Získání indexu (rozhraní REST API služby Azure AI Search)
Operace Získání indexu získá definici indexu ze služby Azure AI Search.
GET https://[service name].search.windows.net/indexes/[index name]?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živatelem definovaný název vaší vyhledávací služby. |
| název indexu | Povinná hodnota. Identifikátor URI požadavku určuje název indexu, který se má vrátit. |
| verze-api | Povinná hodnota. Seznam podporovaných verzí najdete v tématu Verze rozhraní API . |
Hlavičky požadavku
Následující tabulka popisuje požadovanou a volitelnou hlavičku požadavku.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto možnost na application/json |
| klíč rozhraní API | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Pokud používáte klíče rozhraní API, zadejte klíč správce (na rozdíl od klíče dotazu), který vrátí informace o objektu z vyhledávací služby. 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říklad datové části odpovědi najdete v ukázkovém kódu JSON požadavku v tématu Vytvoření indexu (rozhraní REST API služby Azure AI Search ). Text odpovědi Get Index a odpovědi a odpovědi na vytvoření indexu mají stejný formát.