Documents - Get

Dienst:: Search Service

API-Version:: 2026-05-01-preview

Ruft ein Dokument aus dem Index ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes.
key	path	True	string	Der Schlüssel des abzurufenden Dokuments.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$select	query		string[]	Liste der Feldnamen, die für das Dokument abgerufen werden sollen; Im zurückgegebenen Dokument fehlt ein nicht abgerufenes Feld.

Anforderungsheader

Name	Typ	Beschreibung
Accept	Accept	Die Überschrift "Annehmen".
x-ms-query-source-authorization	string	Token, das den Benutzer identifiziert, für den die Abfrage ausgeführt wird. Dieses Token wird verwendet, um Sicherheitseinschränkungen für Dokumente durchzusetzen.
x-ms-enable-elevated-read	boolean	Ein Wert, der erhöhte Lesevorgänge ermöglicht, die Berechtigungsüberprüfungen auf Dokumentebene für den Abfragevorgang umgehen.
x-ms-client-request-id	string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	LookupDocument	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

SearchIndexGetDocument

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name	Typ	Beschreibung
info		Zusätzliche Informationen.
type	string	Typ der Zusatzinformationen.

ErrorDetail

Objekt

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die Zusatzinformationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Der Fehlerzielwert.

ErrorResponse

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.