Auflisten von Indizes (Azure AI Search-REST-API)
Der Vorgang Indizes auflisten gibt eine Liste der Indizes zurück, die sich derzeit in Ihrem Azure KI-Suchdienst befinden.
GET https://[service name].search.windows.net/indexes?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. |
| api-version | Erforderlich. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere 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. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Abrufen von Anforderungen für eine Objektdefinition muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). 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.
Beispiele
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Sie können die Antwort nur nach den gewünschten Eigenschaften filtern. Wenn Sie beispielsweise nur eine Liste der Indexnamen erhalten möchten, verwenden Sie die OData-Abfrageoption $select :
GET /indexes?api-version=2020-06-30&$select=name
In diesem Fall würde die Antwort aus dem obigen Beispiel wie folgt aussehen:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Dies ist ein nützliches Verfahren, um Bandbreite zu sparen, wenn Ihr Suchdienst zahlreiche Indizes beinhaltet.