Indexers - Get Status

Служба:: Search Service

Версия API:: 2025-08-01-preview

Возвращает текущее состояние и историю выполнения индексатора.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2025-08-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
indexerName	path	True	string	Имя индексатора, для которого необходимо получить статус.
api-version	query	True	string	Версия API клиента.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string (uuid)	Идентификатор отслеживания, отправленный вместе с запросом на помощь в отладке.

Ответы

Имя	Тип	Описание
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Ответ на ошибку.

Примеры

SearchServiceGetIndexerStatus

Образец запроса

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-08-01-preview

Пример ответа

Код состояния:: 200

{
  "name": "myindexer",
  "status": "running",
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "details": "The file could not be parsed.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
        }
      ],
      "warnings": [
        {
          "key": "document id",
          "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
IndexerCurrentState	Представляет все состояния, определяющие и определяющие текущее выполнение индексатора.
IndexerExecutionResult	Представляет результат выполнения отдельного индексатора.
IndexerExecutionStatus	Представляет состояние выполнения отдельного индексатора.
IndexerExecutionStatusDetail	Подробно описывает состояние выполнения отдельного индексатора.
IndexerStatus	Представляет общее состояние индексатора.
IndexingMode	Представляет режим, в котором выполняется индексатор.
SearchIndexerError	Представляет собой ошибку индексирования на уровне элемента или документа.
SearchIndexerLimits
SearchIndexerStatus	Представляет текущее состояние и историю выполнения индексатора.
SearchIndexerWarning	Представляет собой предупреждение на уровне элемента.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IndexerCurrentState

Объект

Представляет все состояния, определяющие и определяющие текущее выполнение индексатора.

Имя	Тип	Описание
allDocsFinalTrackingState	string	Изменение значения состояния отслеживания при завершении индексирования для всех документов в источнике данных.
allDocsInitialTrackingState	string	Изменение состояния отслеживания, используемого при запуске индексирования для всех документов в источнике данных.
mode	IndexingMode	Режим, в котором выполняется индексатор.
resetDatasourceDocumentIds	string[]	Список идентификаторов документов источника данных, которые были сброшены. Идентификатор документа источника данных — это уникальный идентификатор данных в источнике данных. Индексатор будет отдавать приоритет выборочному повторному приему этих идентификаторов.
resetDocsFinalTrackingState	string	Изменение значения состояния отслеживания при завершении индексирования при выборе и сбросе документов в источнике данных.
resetDocsInitialTrackingState	string	Изменение состояния отслеживания, используемого при запуске индексирования, при выборе и сбросе документов в источнике данных.
resetDocumentKeys	string[]	Список ключей документа, которые были сброшены. Ключ документа — это уникальный идентификатор документа для данных в индексе поиска. Индексатор будет отдавать приоритет выборочному повторному приему этих ключей.
resyncFinalTrackingState	string	Изменение значения состояния отслеживания при завершении индексации на выборочных параметрах из источника данных.
resyncInitialTrackingState	string	Изменение состояния отслеживания, используемого при запуске индексирования по выборочным параметрам из источника данных.

IndexerExecutionResult

Объект

Представляет результат выполнения отдельного индексатора.

Имя	Тип	Описание
endTime	string (date-time)	Время окончания выполнения этого индексатора, если выполнение уже завершено.
errorMessage	string	Сообщение об ошибке с указанием ошибки верхнего уровня, если таковая имеется.
errors	SearchIndexerError[]	Ошибки индексации на уровне элементов.
finalTrackingState	string	Изменение состояния отслеживания, с которым завершилось выполнение индексатора.
initialTrackingState	string	Изменение состояния отслеживания, с которым началось выполнение индексатора.
itemsFailed	integer (int32)	Количество элементов, которые не удалось проиндексировать во время выполнения этого индексатора.
itemsProcessed	integer (int32)	Количество элементов, которые были обработаны во время выполнения этого индексатора. Сюда входят как успешно обработанные элементы, так и элементы, в которых была предпринята попытка индексирования, но не удалась.
mode	IndexingMode	Режим, в котором выполняется индексатор.
startTime	string (date-time)	Время начала выполнения этого индексатора.
status	IndexerExecutionStatus	Результат выполнения этого индексатора.
statusDetail	IndexerExecutionStatusDetail	Результат выполнения этого индексатора.
warnings	SearchIndexerWarning[]	Предупреждения об индексировании на уровне элементов.

IndexerExecutionStatus

Перечисление

Представляет состояние выполнения отдельного индексатора.

Значение	Описание
transientFailure	Не удалось вызвать индексатор, но этот сбой может быть временным. Вызовы индексатора будут продолжаться по расписанию.
success	Выполнение индексатора завершено успешно.
inProgress	Выполняется выполнение индексатора.
reset	Индексатор был сброшен.

IndexerExecutionStatusDetail

Перечисление

Подробно описывает состояние выполнения отдельного индексатора.

Значение	Описание
resetDocs	Указывает, что выполненный сброс был выполнен для вызова ResetDocs.
resync	Указывает на выборочную повторную синхронизацию на основе опций из источника данных.

IndexerStatus

Перечисление

Представляет общее состояние индексатора.

Значение	Описание
unknown	Указывает, что индексатор находится в неизвестном состоянии.
error	Указывает, что в индексаторе произошла ошибка, которую невозможно исправить без вмешательства человека.
running	Указывает, что индексатор работает нормально.

IndexingMode

Перечисление

Представляет режим, в котором выполняется индексатор.

Значение	Описание
indexingAllDocs	Индексатор индексирует все документы в источнике данных.
indexingResetDocs	Индексатор индексирует выборочные, сбрасываемые документы в источнике данных. Индексируемые документы определяются по статусу индексатора.
indexingResync	Индексатор повторно синхронизирует и индексирует выборочные параметры из источника данных.

SearchIndexerError

Объект

Представляет собой ошибку индексирования на уровне элемента или документа.

Имя	Тип	Описание
details	string	Дополнительные, подробные сведения об ошибке для помощи в отладке индексатора. Это может быть доступно не всегда.
documentationLink	string	Ссылка на руководство по устранению неполадок для этих классов ошибок. Это может быть доступно не всегда.
errorMessage	string	Сообщение с описанием ошибки, возникшей при обработке элемента.
key	string	Ключ элемента, для которого не удалось индексировать.
name	string	Имя источника, в котором возникла ошибка. Например, это может относиться к определенному навыку в прикрепленном наборе навыков. Это может быть доступно не всегда.
statusCode	integer (int32)	Код состояния, указывающий на причину сбоя операции индексирования. Возможные значения: 400 для неправильно сформированного входного документа, 404 для документа не найден, 409 для конфликта версий, 422, когда индекс временно недоступен, или 503, когда служба слишком занята.

SearchIndexerLimits

Объект

Имя	Тип	Описание
maxDocumentContentCharactersToExtract	number (int64)	Максимальное количество символов, которое будет извлечено из документа, выбранного для индексации.
maxDocumentExtractionSize	number (int64)	Максимальный размер документа (в байтах), который будет считаться допустимым для индексации.
maxRunTime	string (duration)	Максимальная продолжительность, в течение которой индексатору разрешено работать в течение одного выполнения.

SearchIndexerStatus

Объект

Представляет текущее состояние и историю выполнения индексатора.

Имя	Тип	Описание
currentState	IndexerCurrentState	Все состояние, которое определяет и диктует текущее выполнение индексатора.
executionHistory	IndexerExecutionResult[]	История последних выполнений индексаторов, отсортированная в обратном хронологическом порядке.
lastResult	IndexerExecutionResult	Результат последнего или выполняемого выполнения индексатора.
limits	SearchIndexerLimits	Ограничения на выполнение для индексатора.
name	string	Имя индексатора.
status	IndexerStatus	Общее состояние индексатора.

SearchIndexerWarning

Объект

Представляет собой предупреждение на уровне элемента.

Имя	Тип	Описание
details	string	Дополнительные, подробные сведения о предупреждении, которые помогут в отладке индексатора. Это может быть доступно не всегда.
documentationLink	string	Ссылка на руководство по устранению неполадок для этих классов предупреждений. Это может быть доступно не всегда.
key	string	Ключ элемента, который выдал предупреждение.
message	string	Сообщение с описанием предупреждения, возникшего при обработке элемента.
name	string	Название источника, из которого было отправлено предупреждение. Например, это может относиться к определенному навыку в прикрепленном наборе навыков. Это может быть доступно не всегда.