Indexek listázása (Azure Cognitive Search REST API)

Az Indexek listázása művelet a Azure Cognitive Search szolgáltatásban jelenleg található indexek listáját adja vissza.

GET https://[service name].search.windows.net/indexes?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]  

URI-paraméterek

Paraméter Leírás
szolgáltatásnév Kötelező. Állítsa be ezt a keresési szolgáltatás egyedi, felhasználó által definiált nevére.
api-verzió Kötelező. A jelenlegi stabil verzió a api-version=2020-06-30. További verziókért tekintse meg az API-verziókat .

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Mezők Description
Content-Type Kötelező. Állítsa ezt a következőre: application/json
api-key Kötelező. Az API-kulccsal hitelesítheti a kérést a Search szolgáltatás. Ez egy sztringérték, amely egyedi a szolgáltatás számára. A szolgáltatásban lévő objektumokra vonatkozó kéréseknek tartalmazniuk kell egy, a rendszergazdai kulcsra beállított API-kulcs mezőt (a lekérdezési kulcs helyett). Az API-kulcsot a keresési szolgáltatás irányítópultján találja a Azure Portal.

Kérelem törzse

Nincsenek.

Reagálás

Állapotkód: Sikeres válasz esetén a rendszer a "200 OK" értéket adja vissza.

Példák

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

A választ csak az önt érdeklő tulajdonságokra szűrheti. Ha például csak az indexnevek listáját szeretné látni, használja az OData $select lekérdezési lehetőséget:

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

Ebben az esetben a fenti példa válasza a következőképpen jelenik meg:

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

Ez hasznos módszer a sávszélesség megtakarítására, ha sok index található a Search szolgáltatás.

Lásd még

REST API-k Azure Cognitive Search
Indexműveletek (Azure Cognitive Search REST API)