Share via

Získání Indexeru (rozhraní REST API služby Azure AI Search)

  • Článek

Operace Get Indexer získá definici indexeru ze služby 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 identifikátoru URI

Parametr Popis
název služby Povinná hodnota. Nastavte jedinečný, uživatelem definovaný název vaší vyhledávací služby.
název indexeru Povinná hodnota. Identifikátor URI požadavku určuje název indexeru, který se má vrátit.
verze-api Seznam podporovaných verzí 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. Nastavit 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íč. Pokud používáte klíče rozhraní API, zadejte klíč správce (nikoli klíč 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ěď

Stavový kód: Pro úspěšnou odpověď se vrátí hodnota 200 OK. Odpověď je podobná příkladům v tématu Vytvoření indexeru (Rozhraní REST API služby 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
}

Poznámka

Pokud má indexer šifrovací klíč, musí mít vyhledávací služba přístup k šifrovacímu klíči, aby načetla definici indexeru. Bez přístupu k šifrovacímu klíči se vrátí chybný požadavek 400. Obnovení přístupu ke klíči umožní vyhledávací službě znovu načíst definici indexeru.

Viz také