Uzyskiwanie indeksu (interfejs API REST usługi Azure AI Search)
Operacja Pobierz indeks pobiera definicję indeksu z usługi 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 identyfikatora URI
| Parametr | Opis |
|---|---|
| nazwa usługi | Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. |
| nazwa indeksu | Wymagane. Identyfikator URI żądania określa nazwę indeksu do zwrócenia. |
| api-version | Wymagane. Zobacz Wersje interfejsu API , aby uzyskać listę obsługiwanych wersji. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
| Pola | Opis |
|---|---|
| Content-Type | Wymagane. Ustaw tę wartość na application/json |
| api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Jeśli używasz kluczy interfejsu API, określ klucz administratora (w przeciwieństwie do klucza zapytania), aby zwrócić informacje o obiekcie z usługi wyszukiwania. Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza . |
Treść żądania
Brak.
Reakcja
Kod stanu: "200 OK" jest zwracany dla pomyślnej odpowiedzi. Zobacz przykładowy kod JSON żądania w artykule Create Index (Interfejs API REST usługi Azure AI Search), aby zapoznać się z przykładem ładunku odpowiedzi. Treść odpowiedzi Get Index i treść tworzenia indeksu i treści odpowiedzi są takie same jak w tym samym formacie.