Freigeben über

Documents - Get

Dienst:
Search Service
API-Version:
2025-09-01

Ruft ein Dokument aus dem Index ab.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-09-01
Mit optionalen Parametern: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-09-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

Die Endpunkt-URL des Suchdiensts.
indexName
 path True

string

Der Name des Index.
key
 path True

string

Der Schlüssel des abzurufenden Dokuments.
api-version
 query True

string

Client-API-Version.
$select
 query

string[]

Liste der Feldnamen, die für das Dokument abgerufen werden sollen; Jedes Feld, das nicht abgerufen wird, fehlt im zurückgegebenen Dokument.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.

Antworten

Name Typ Beschreibung
200 OK

LookupDocument

Antwort mit dem angeforderten Dokument.
Other Status Codes

ErrorResponse

Fehlerantwort.

Beispiele

SearchIndexGetDocument

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.