Indexers - Get Status

Ссылка

Служба:: Search Service

Версия API:: 2024-05-01-preview

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-05-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://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-05-01-preview

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

Код состояния:: 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	Сообщение об ошибке
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

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

Имя	Тип	Описание
allDocsFinalChangeTrackingState	string	Значение состояния отслеживания изменений при завершении индексирования для всех документов в источнике данных.
allDocsInitialChangeTrackingState	string	Состояние отслеживания изменений, используемое при запуске индексирования для всех документов в источнике данных.
mode	IndexingMode	Режим, в котором выполняется индексатор.
resetDatasourceDocumentIds	string[]	Список идентификаторов документов источника данных, которые были сброшены. Идентификатор документа источника данных — это уникальный идентификатор данных в источнике данных. Индексатор будет определять приоритет выборочного повторного приема этих идентификаторов.
resetDocsFinalChangeTrackingState	string	Изменение значения состояния отслеживания после завершения индексирования при выборе и сбросе документов в источнике данных.
resetDocsInitialChangeTrackingState	string	Состояние отслеживания изменений, используемое при запуске индексирования при выборе и сбросе документов в источнике данных.
resetDocumentKeys	string[]	Список ключей документов, которые были сброшены. Ключ документа — это уникальный идентификатор документа для данных в индексе поиска. Индексатор будет определять приоритет выборочного повторного приема этих ключей.

IndexerExecutionResult

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

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

IndexerExecutionStatus

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

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

IndexerExecutionStatusDetail

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

Имя	Тип	Описание
resetDocs	string	Указывает, что произошел сброс для вызова ResetDocs.

IndexerStatus

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

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

IndexingMode

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

Имя	Тип	Описание
indexingAllDocs	string	Индексатор индексирует все документы в источнике данных.
indexingResetDocs	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	Имя источника, от которого возникло предупреждение. Например, это может относиться к определенному навыку в присоединенном наборе навыков. Это может быть не всегда доступно.

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