Documents - Get

서비스:

Search Service

API 버전:

2026-04-01

인덱스에서 문서를 검색합니다.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01

선택적 매개 변수:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01&$select={$select}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)	검색 서비스의 엔드포인트 URL입니다.
indexName	path	True	string	인덱스의 이름입니다.
key	path	True	string	검색할 문서의 키입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
$select	query		string[]	문서에 대해 검색할 필드 이름 목록입니다. 검색되지 않은 모든 필드는 반환된 문서에서 누락됩니다.

요청 헤더

Name	필수	형식	Description
Accept		Accept	Accept 헤더입니다.
x-ms-client-request-id		string (uuid)	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

응답

Name	형식	Description
200 OK	LookupDocument	요청이 성공했습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

api-key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

범위

Name	Description
https://search.azure.com/.default

예제

SearchIndexGetDocument

샘플 요청

HTTP

GET https://exampleservice.search.windows.net/indexes('example-index')/docs('1')?api-version=2026-04-01&$select=id,description,name,category,ownerId

샘플 응답

상태 코드:

200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

정의

Name	Description
Accept	Accept 헤더입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

Accept

열거형

Accept 헤더입니다.

값	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

Name	형식	Description
error	ErrorDetail	오류 개체입니다.