Abrufen von Index (Azure KI Search-REST-API)
Der Vorgang Index abrufen ruft die Indexdefinition aus Azure KI Search ab.
GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-Parameter
| Parameter | BESCHREIBUNG |
|---|---|
| Dienstname | Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest. |
| Indexname | Erforderlich. Der Anforderungs-URI gibt den Namen des zurückzugebenden Indexes an. |
| api-version | Erforderlich. Eine Liste der unterstützten Versionen finden Sie unter API-Versionen . |
Anforderungsheader
Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.
| Felder | BESCHREIBUNG |
|---|---|
| Content-Type | Erforderlich. Auf application/json |
| api-key | Optional, wenn Sie Azure-Rollen verwenden und in der Anforderung ein Bearertoken bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Wenn Sie API-Schlüssel verwenden, geben Sie einen Administratorschlüssel (im Gegensatz zu einem Abfrageschlüssel) an, um Objektinformationen vom Suchdienst zurückzugeben. Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung . |
Anforderungstext
Keine.
Antwort
Statuscode: "200 OK" wird für eine erfolgreiche Antwort zurückgegeben. Ein Beispiel für die Antwortnutzlast finden Sie in der JSON-Beispielanforderung in Create Index (Azure AI Search REST API). Der Antworttext "Index abrufen" und die Antworttexte "Index erstellen" und "Antworttexte" haben alle das gleiche Format.