Hämta indexerare (REST API för Azure AI Search)

  • Artikel

Åtgärden Get Indexer hämtar indexeringsdefinitionen från 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]

URI-parametrar

Parameter Beskrivning
tjänstnamn Krävs. Ange det unika, användardefinierade namnet på söktjänsten.
indexerarens namn Krävs. Begärande-URI anger namnet på indexeraren som ska returneras.
api-version 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 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. Svaret liknar exemplen i Create Indexer (Azure AI Search REST API):

{  
    "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
}

Anteckning

Om indexeraren har en krypteringsnyckel måste söktjänsten ha åtkomst till krypteringsnyckeln för att hämta indexerarens definition. Utan åtkomst till krypteringsnyckeln returneras en 400 Felaktig begäran. Om du återställer åtkomsten till nyckeln kan söktjänsten hämta indexeringsdefinitionen igen.

Se även