Indexers - Get Status

참조

서비스:: Search Service

API 버전:: 2024-03-01-Preview

인덱서의 현재 상태와 실행 기록을 반환합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
indexerName	path	True	string	상태를 검색할 인덱서의 이름입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	디버깅에 도움이 되는 요청과 함께 전송된 추적 ID입니다.

응답

Name	형식	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	오류 응답입니다.

예제

SearchServiceGetIndexerStatus

샘플 요청

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-03-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
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
IndexerCurrentState	인덱서의 현재 실행을 정의하고 지시하는 모든 상태를 나타냅니다.
IndexerExecutionResult	개별 인덱서 실행의 결과를 나타냅니다.
IndexerExecutionStatus	개별 인덱서 실행의 상태를 나타냅니다.
IndexerExecutionStatusDetail	개별 인덱서 실행의 상태 자세히 설명합니다.
IndexerStatus	전반적인 인덱서 상태를 나타냅니다.
IndexingMode	인덱서가 실행 중인 모드를 나타냅니다.
SearchIndexerError	항목 또는 문서 수준 인덱싱 오류를 나타냅니다.
SearchIndexerLimits
SearchIndexerStatus	인덱서의 현재 상태와 실행 기록을 나타냅니다.
SearchIndexerWarning	항목 수준 경고를 나타냅니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

IndexerCurrentState

인덱서의 현재 실행을 정의하고 지시하는 모든 상태를 나타냅니다.

Name	형식	Description
allDocsFinalChangeTrackingState	string	데이터 원본의 모든 문서에서 인덱싱이 완료되면 추적 상태 값을 변경합니다.
allDocsInitialChangeTrackingState	string	데이터 원본의 모든 문서에서 인덱싱이 시작될 때 사용되는 변경 내용 추적 상태입니다.
mode	IndexingMode	인덱서가 실행 중인 모드입니다.
resetDatasourceDocumentIds	string[]	재설정된 데이터 원본 문서 ID 목록입니다. 데이터 원본 문서 ID는 데이터 원본의 데이터에 대한 고유 식별자입니다. 인덱서는 이러한 ID를 선택적으로 다시 수집하는 우선 순위를 지정합니다.
resetDocsFinalChangeTrackingState	string	선택 시 인덱싱이 완료되면 추적 상태 값을 변경하고 데이터 원본에서 문서를 다시 설정합니다.
resetDocsInitialChangeTrackingState	string	선택 시 인덱싱이 시작될 때 사용되는 변경 내용 추적 상태이며, 데이터 원본에서 문서를 다시 설정합니다.
resetDocumentKeys	string[]	다시 설정된 문서 키 목록입니다. 문서 키는 검색 인덱스의 데이터에 대한 문서의 고유 식별자입니다. 인덱서는 이러한 키를 선택적으로 다시 수집하는 우선 순위를 지정합니다.

IndexerExecutionResult

개별 인덱서 실행의 결과를 나타냅니다.

Name	형식	Description
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

개별 인덱서 실행의 상태를 나타냅니다.

Name	형식	Description
inProgress	string	인덱서 실행이 진행 중입니다.
reset	string	인덱서가 다시 설정되었습니다.
success	string	인덱서 실행이 완료되었습니다.
transientFailure	string	인덱서 호출에 실패했지만 이는 일시적인 현상일 수 있습니다. 인덱서 호출은 일정에 따라 계속됩니다.

IndexerExecutionStatusDetail

개별 인덱서 실행의 상태 자세히 설명합니다.

Name	형식	Description
resetDocs	string	발생한 초기화가 ResetDocs 호출에 대한 것임을 나타냅니다.

IndexerStatus

전반적인 인덱서 상태를 나타냅니다.

Name	형식	Description
error	string	인덱서에 사람의 개입 없이는 수정할 수 없는 오류가 발생했음을 나타냅니다.
running	string	인덱서가 정상적으로 실행 중임을 나타냅니다.
unknown	string	인덱서가 알 수 없는 상태임을 나타냅니다.

IndexingMode

인덱서가 실행 중인 모드를 나타냅니다.

Name	형식	Description
indexingAllDocs	string	인덱서가 데이터 원본의 모든 문서를 인덱싱하고 있습니다.
indexingResetDocs	string	인덱서가 선택적 인덱싱하고 데이터 원본에서 문서를 다시 설정합니다. 인덱싱되는 문서는 인덱서 상태 정의됩니다.

SearchIndexerError

항목 또는 문서 수준 인덱싱 오류를 나타냅니다.

Name	형식	Description
details	string	또한 인덱서 디버깅에 도움이 되도록 오류에 대한 자세한 정보를 제공합니다. 항상 사용할 수 있는 것은 아닙니다.
documentationLink	string	이러한 오류 클래스에 대한 문제 해결 가이드에 대한 링크입니다. 항상 사용할 수 있는 것은 아닙니다.
errorMessage	string	항목을 처리하는 동안 발생한 오류를 설명하는 메시지입니다.
key	string	인덱싱에 실패한 항목의 키입니다.
name	string	오류가 발생한 원본의 이름입니다. 예를 들어 연결된 기술 세트의 특정 기술을 참조할 수 있습니다. 항상 사용할 수 있는 것은 아닙니다.
statusCode	integer	인덱싱 작업이 실패한 이유를 나타내는 상태 코드입니다. 가능한 값은 형식이 잘못된 입력 문서의 경우 400, 문서를 찾을 수 없는 경우 404, 버전 충돌의 경우 409, 인덱스가 일시적으로 사용할 수 없는 경우 422, 서비스가 너무 많은 경우 503입니다.

SearchIndexerLimits

Name	형식	Description
maxDocumentContentCharactersToExtract	number	인덱싱을 위해 선택한 문서에서 추출할 최대 문자 수입니다.
maxDocumentExtractionSize	number	인덱싱에 유효한 것으로 간주되는 문서의 최대 크기(바이트)입니다.
maxRunTime	string	인덱서가 한 번의 실행에 대해 실행할 수 있는 최대 기간입니다.

SearchIndexerStatus

인덱서의 현재 상태와 실행 기록을 나타냅니다.

Name	형식	Description
executionHistory	IndexerExecutionResult[]	역순으로 정렬된 최근 인덱서 실행의 기록입니다.
lastResult	IndexerExecutionResult	가장 최근 또는 진행 중인 인덱서 실행의 결과입니다.
limits	SearchIndexerLimits	인덱서에 대한 실행 제한입니다.
status	IndexerStatus	전반적인 인덱서 상태입니다.

SearchIndexerWarning

항목 수준 경고를 나타냅니다.

Name	형식	Description
details	string	또한 인덱서 디버깅에 도움이 되도록 경고에 대한 자세한 정보를 제공합니다. 항상 사용할 수 있는 것은 아닙니다.
documentationLink	string	이러한 경고 클래스에 대한 문제 해결 가이드에 대한 링크입니다. 항상 사용할 수 있는 것은 아닙니다.
key	string	경고를 생성한 항목의 키입니다.
message	string	항목을 처리하는 동안 발생한 경고를 설명하는 메시지입니다.
name	string	경고가 발생한 원본의 이름입니다. 예를 들어 연결된 기술 세트의 특정 기술을 참조할 수 있습니다. 항상 사용할 수 있는 것은 아닙니다.

다음을 통해 공유