Výpis indexů (rozhraní REST API služby Azure AI Search)
Operace List Indexes vrátí seznam indexů, které jsou aktuálně ve vašem Search Azure AI.
GET https://[service name].search.windows.net/indexes?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identifikátoru URI
| Parametr | Popis |
|---|---|
| název služby | Povinná hodnota. Nastavte ho na jedinečný uživatelsky definovaný název vaší vyhledávací služby. |
| verze-api | Povinná hodnota. Aktuální stabilní verze je api-version=2020-06-30. Další verze najdete v tématu Verze rozhraní API . |
Hlavičky požadavku
Následující tabulka popisuje požadované a volitelné hlavičky požadavků.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto možnost na application/json |
| api-key | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný systémově vygenerovaný řetězec, který ověřuje požadavek pro vaši vyhledávací službu. Požadavky na získání definice objektu musí obsahovat pole api-key nastavené na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče . |
Text požadavku
Žádné
Odpověď
Pro úspěšnou odpověď se vrátí stavový kód 200 OK.
Příklady
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Odpověď můžete filtrovat jenom podle vlastností, které vás zajímají. Pokud například chcete jenom seznam názvů indexů, použijte možnost dotazu OData $select :
GET /indexes?api-version=2020-06-30&$select=name
V tomto případě by odpověď z výše uvedeného příkladu vypadala takto:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Toto je užitečná technika pro úsporu šířky pásma, pokud máte v Search velké množství indexů.