Indexek listázása (Azure AI Search REST API)
Az Indexek listázása művelet az Azure AI-Search szolgáltatás aktuális indexeinek listáját adja vissza.
GET https://[service name].search.windows.net/indexes?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-paraméterek
| Paraméter | Leírás |
|---|---|
| szolgáltatásnév | Kötelező. Állítsa be ezt a keresési szolgáltatás egyedi, felhasználó által definiált nevére. |
| api-verzió | Kötelező. A jelenlegi stabil verzió a következő api-version=2020-06-30: . További verziókért lásd: API-verziók . |
Kérelemfejlécek
Az alábbi táblázat a szükséges és nem kötelező kérésfejléceket ismerteti.
| Mezők | Description |
|---|---|
| Content-Type | Kötelező. Állítsa a következőre: application/json |
| api-key | Nem kötelező , ha Azure-szerepköröket használ, és egy tulajdonosi jogkivonatot ad meg a kéréshez, ellenkező esetben kulcsra van szükség. Az API-kulcs egy egyedi, rendszer által generált sztring, amely hitelesíti a kérést a keresési szolgáltatásnak. Az objektumdefiníciók kéréseinek tartalmazniuk kell egy api-key mezőt, amely a rendszergazdai kulcsra van állítva (a lekérdezési kulcs helyett). A részletekért lásd: Csatlakozás az Azure AI Search szolgáltatáshoz kulcshitelesítés használatával . |
Kérelem törzse
Nincsenek.
Reagálás
Állapotkód: A rendszer az "200 OK" értéket adja vissza a sikeres válaszhoz.
Példák
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
A választ a kívánt tulajdonságokra szűrheti le. Ha például csak az indexnevek listáját szeretné látni, használja az OData $select lekérdezési lehetőséget:
GET /indexes?api-version=2020-06-30&$select=name
Ebben az esetben a fenti példa válasza a következőképpen jelenik meg:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Ez egy hasznos módszer a sávszélesség megtakarítására, ha sok index van a Search szolgáltatás.