Hämta index (REST API för Azure AI Search)
Åtgärden Hämta index hämtar indexdefinitionen från 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]
URI-parametrar
| Parameter | Beskrivning |
|---|---|
| tjänstnamn | Krävs. Ange det unika, användardefinierade namnet på söktjänsten. |
| indexnamn | Krävs. Begärande-URI anger namnet på indexet som ska returneras. |
| api-version | Krävs. En lista över versioner som stöds finns i API-versioner . |
Rubriker för begäran
I följande tabell beskrivs nödvändiga och valfria begärandehuvuden.
| Fält | Description |
|---|---|
| Content-Type | Krävs. Ange detta till application/json |
| api-key | Valfritt om du använder Azure-roller och en ägartoken anges på begäran, annars krävs en nyckel. Om du använder API-nycklar anger du en administratörsnyckel (till skillnad från en frågenyckel) för att returnera objektinformation från söktjänsten. Mer information finns i Ansluta till Azure AI Search med nyckelautentisering . |
Begärandetext
Inga.
Svarsåtgärder
Statuskod: "200 OK" returneras för ett lyckat svar. Se exempelbegäran JSON i Create Index (Azure AI Search REST API) för ett exempel på svarsnyttolasten. Svarstexten Hämta index och Svars- och svarskropparna Skapa index har samma format.