Indexers - Get Status

Служба:: Search Service

Версия API:: 2026-04-01

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2026-04-01

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	SearchIndexerStatus	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

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

HTTP

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

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

Код состояния:: 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,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "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
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

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

HTTP

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

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

Код состояния:: 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,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "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
  }
}

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
IndexerExecutionResult	Представляет результат выполнения отдельного индексатора.
IndexerExecutionStatus	Представляет состояние выполнения отдельного индексатора.
IndexerStatus	Представляет общее состояние индексатора.
SearchIndexerError	Представляет ошибку индексирования на уровне элемента или документа.
SearchIndexerLimits	Представляет пределы, которые можно применить к индексатору.
SearchIndexerStatus	Представляет текущее состояние и журнал выполнения индексатора.
SearchIndexerWarning	Представляет предупреждение уровня элемента.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

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

IndexerExecutionResult

Объект

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

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

IndexerExecutionStatus

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

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

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

IndexerStatus

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

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

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

SearchIndexerError

Объект

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

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

SearchIndexerLimits

Объект

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

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

SearchIndexerStatus

Объект

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

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

SearchIndexerWarning

Объект

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

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