Pobieranie indeksatora (interfejs API REST usługi Azure AI Search)
Operacja Get Indexer pobiera definicję indeksatora z usługi Azure AI Search.
GET https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identyfikatora URI
Parametr | Opis |
---|---|
nazwa usługi | Wymagane. Ustaw unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. |
nazwa indeksatora | Wymagane. Identyfikator URI żądania określa nazwę indeksatora do zwrócenia. |
api-version | 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 wartość application/json |
api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest udostępniany 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 zwracana dla pomyślnej odpowiedzi. Odpowiedź jest podobna do przykładów w temacie Create Indexer (Interfejs API REST usługi Azure AI Search)::
{
"name" : "myindexer",
"description" : "a cool indexer",
"dataSourceName" : "ordersds",
"targetIndexName" : "orders",
"schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },
"parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
"encryptionKey": null
}
Uwaga
Jeśli indeksator ma klucz szyfrowania, usługa wyszukiwania musi mieć dostęp do klucza szyfrowania w celu pobrania definicji indeksatora. Bez dostępu do klucza szyfrowania zwracany jest błąd 400 Nieprawidłowe żądanie. Przywrócenie dostępu do klucza umożliwia usłudze wyszukiwania ponowne pobranie definicji indeksatora.