Documents - Get

Tjänst:: Search Service

API-version:: 2025-11-01-preview

Hämtar ett dokument från indexet.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-11-01-preview

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
key	path	True	string	Nyckeln till dokumentet som ska hämtas.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$select	query		string[]	Lista över fältnamn som ska hämtas för dokumentet. Alla fält som inte hämtas saknas i det returnerade dokumentet.

Begärandehuvud

Name	Typ	Description
x-ms-client-request-id	string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept	Accept	Acceptera-rubriken.
x-ms-query-source-authorization	string	Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument.
x-ms-enable-elevated-read	boolean	Ett värde som möjliggör förhöjd läsning som kringgår behörighetskontroller på dokumentnivå för frågeåtgärden.

Svar

Name	Typ	Description
200 OK	LookupDocument	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

SearchIndexGetDocument

Exempelbegäran

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?api-version=2025-11-01-preview&$select=id,description,name,category,ownerId

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.