다음을 통해 공유


목록 인덱서(Azure AI Search REST API)

인덱서 나열 작업은 Azure AI Search Service 인덱서 목록을 반환합니다.

GET https://[service name].search.windows.net/indexers?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]  

URI 매개 변수

매개 변수 Description
서비스 이름 필수 사항입니다. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다.
api-version 필수 사항입니다. 현재 안정적인 버전은 입니다 api-version=2020-06-30. 더 많은 버전은 API 버전을 참조하세요.

요청 헤더

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

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

요청 본문

없음

응답

요청이 성공적으로 실행되면 '200 OK'가 반환됩니다. 아래에는 예제 응답 본문이 나와 있습니다.

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

응답을 관심 있는 속성으로 필터링할 수 있습니다. 예를 들어 인덱서 이름 목록만 원하는 경우 OData $select 쿼리 옵션을 사용합니다.

GET /indexers?api-version=2020-06-30&$select=name  

이 경우 위 예제의 응답은 다음과 같이 표시됩니다.

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

이 기술은 Search 서비스에 많은 인덱서가 있는 경우 대역폭을 절감하는 데 유용합니다.

참고

인덱서에 암호화 키가 있는 경우 검색 서비스는 암호화 키에 액세스하여 해당 인덱서 정의에서 암호화된 속성을 검색해야 합니다. 암호화 키 "<encrypted>" 에 액세스하지 않으면 암호화된 속성 대신 자리 표시자가 반환됩니다. 키에 대한 액세스를 복원하면 검색 서비스에서 전체 인덱서 정의를 다시 검색할 수 있습니다.

참고 항목