Indexers - Get Status

Ссылка

Служба:: Search Service

Версия API:: 2024-07-01

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

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

Параметры 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://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-07-01

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

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

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "errorMessage": null,
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "errors": [],
    "warnings": [],
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "initialTrackingState": null,
    "finalTrackingState": null
  },
  "executionHistory": [
    {
      "status": "success",
      "errorMessage": null,
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "errors": [],
      "warnings": [],
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "initialTrackingState": null,
      "finalTrackingState": null
    },
    {
      "status": "transientFailure",
      "errorMessage": null,
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "errors": [
        {
          "key": "",
          "errorMessage": "Document key cannot be missing or empty.",
          "statusCode": 400,
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 1",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "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.",
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 2",
          "message": "Document was truncated to 50000 characters.",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "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"
        }
      ],
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "initialTrackingState": null,
      "finalTrackingState": null
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Определения

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

IndexerExecutionResult

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

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

IndexerExecutionStatus

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

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

IndexerStatus

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

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

SearchIndexerError

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

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

SearchIndexerLimits

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

SearchIndexerStatus

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

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

SearchIndexerWarning

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

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

Поделиться через