Dela via


Lista indexerare (REST API för Azure AI Search)

Åtgärden List Indexers returnerar listan över indexerare i din Azure AI-tjänsten Search.

GET https://[service name].search.windows.net/indexers?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.
api-version Krävs. Den aktuella stabila versionen är api-version=2020-06-30. Se API-versioner för fler 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. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till söktjänsten. Hämta begäranden om en objektdefinition måste innehålla ett API-nyckelfält som angetts till din administratörsnyckel (till skillnad från en frågenyckel). Mer information finns i Ansluta till Azure AI Search med nyckelautentisering .

Begärandetext

Inga.

Svarsåtgärder

För en lyckad begäran: 200 OK. Här är ett exempel på svarstext:

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

Du kan filtrera ned svaret till bara de egenskaper som du är intresserad av. Om du till exempel bara vill ha en lista med indexerarnamn använder du frågealternativet OData $select :

GET /indexers?api-version=2020-06-30&$select=name  

I det här fallet visas svaret från exemplet ovan på följande sätt:

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

Det här är en användbar teknik för att spara bandbredd om du har många indexerare i tjänsten Search.

Anteckning

Om en indexerare har en krypteringsnyckel måste söktjänsten ha åtkomst till krypteringsnyckeln för att hämta krypterade egenskaper i indexerarens definition. Utan åtkomst till krypteringsnyckeln returneras en "<encrypted>" platshållare i stället för de krypterade egenskaperna. Om du återställer åtkomsten till nyckeln kan söktjänsten hämta den fullständiga indexeringsdefinitionen igen.

Se även