Lista index (Azure Cognitive Search REST API)

Åtgärden Listindex returnerar en lista över de index som för närvarande finns i din Azure Cognitive Search-tjänst.

GET https://[service name].search.windows.net/indexes?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	Beskrivning
Content-Type	Krävs. Ange detta till application/json
api-key	Krävs. API-nyckeln används för att autentisera begäran till din tjänsten Search. Det är ett strängvärde som är unikt för din tjänst. Hämta begäranden om objekt i tjänsten måste innehålla ett API-nyckelfält som är inställt på din administratörsnyckel (till skillnad från en frågenyckel). Du hittar API-nyckeln på instrumentpanelen för söktjänsten i Azure Portal.

Begärandetext

Inga.

Svarsåtgärder

Statuskod: "200 OK" returneras för ett lyckat svar.

Exempel

{  
  "value": [  
    {  
      "name": "Books",  
      "fields": [  
        {"name": "ISBN", ...},  
        ...  
      ]  
    },  
    {  
      "name": "Games",  
      ...  
    },  
    ...  
  ]  
}  

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

GET /indexes?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": "Books"},  
    {"name": "Games"},  
    ...  
  ]  
}  

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

Se även

Azure Cognitive Search REST-API:er
Indexåtgärder (Azure Cognitive Search REST API)