인덱서 상태 가져오기(Azure AI Search REST API)

아티클
05/10/2023

인덱서 상태 가져오기 작업은 인덱서의 현재 상태 및 실행 기록을 검색합니다.

GET https://[service name].search.windows.net/indexers/[indexer name]/status?api-version=[api-version]&failIfCannotDecrypt=[true|false]
  Content-Type: application/json  
  api-key: [admin key]

URI 매개 변수

매개 변수	Description
서비스 이름	필수 사항입니다. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다.
인덱서 이름	필수 사항입니다. 요청 URI는 상태 반환해야 하는 인덱서의 이름을 지정합니다.
api-version	필수 사항입니다. 현재 안정적인 버전은 입니다 `api-version=2020-06-30`. 더 많은 버전은 API 버전을 참조하세요.
failIfCannotDecrypt	선택 사항이며, 지정하지 않으면 기본값은 true입니다. 암호화 키를 사용하여 인덱서가 만들어졌고 검색 서비스에 암호화 키에 대한 액세스 권한이 없는 경우 인덱서 상태 검색하지 못합니다. false이면 반환된 인덱서 상태 자리 표시자로 대체 `"<encrypted>"` 된 암호화된 속성이 있습니다.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

필드 Description

콘텐츠 형식 필수 사항입니다. application/json

api-key Azure 역할을 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항이며, 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 개체 정의에 대한 가져오기 요청에는 쿼리 키가 아닌 관리자 키로 설정된 api-key 필드가 포함되어야 합니다. 자세한 내용은 키 인증을 사용하여 Azure AI Search에 연결을 참조하세요.

필드	Description
콘텐츠 형식	필수 사항입니다. `application/json`
api-key	Azure 역할을 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항이며, 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 개체 정의에 대한 가져오기 요청에는 쿼리 키가 아닌 관리자 키로 설정된 api-key 필드가 포함되어야 합니다. 자세한 내용은 키 인증을 사용하여 Azure AI Search에 연결을 참조하세요.

요청 본문

없음

응답

상태 코드: 응답에 성공하면 ‘200 OK’가 반환됩니다. 응답 본문에는 전체 인덱서 상태 상태, 마지막 인덱서 호출 및 최근 인덱서 호출 기록(있는 경우)에 대한 정보가 포함됩니다.

아래에 샘플 응답 본문이 나와 있습니다.

{
    "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" : "",
                    "name" : "The operation name describing where the error occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "errorMessage" : "Document key cannot be missing or empty.",
                    "statusCode" : 400,
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'""
                }
            ],
            "warnings" : [
                {
                    "key" : "document id",
                    "name" : "The operation name describing where the warning occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "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."
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'"
                }
            ],
            "itemsProcessed" : 1,
            "itemsFailed" : 1,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        }
    ]
}

참고

암호화 키를 사용하여 인덱서가 만들어진 경우 검색 서비스에서 암호화 키에 액세스할 수 있는 경우에만 상태 암호화된 속성을 검색할 수 있습니다. 검색 서비스에 암호화 키에 대한 액세스 권한이 없는 경우 기본적으로 400 잘못된 요청이 반환됩니다. 암호화된 속성을 대체하는 자리 표시자가 있는 "<encrypted>" 상태 검색하려면 를 지정 failIfCannotDecrypt=false 합니다.