Documents - Get

Tjänst:: Search Service

API-version:: 2026-04-01

Hämtar ett dokument från indexet.

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

Med valfria parametrar:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01&$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	Obligatorisk	Typ	Description
Accept		Accept	Acceptera-rubriken.
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

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://exampleservice.search.windows.net/indexes('example-index')/docs('1')?api-version=2026-04-01&$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	Felmålet.

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.