Enumeración de índices (API REST de Azure Cognitive Search)

La operación List Indexes devuelve una lista de los índices que se encuentran actualmente en el servicio Azure Cognitive Search.

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

Parámetros de identificador URI

Parámetro Descripción
nombre del servicio Necesario. Establézcalo en el nombre único definido por el usuario del servicio de búsqueda.
api-version Necesario. La versión estable actual es api-version=2020-06-30. Consulte Versiones de API para obtener más versiones.

Encabezados de solicitud

En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.

Campos Descripción
Content-Type Necesario. Establézcalo en application/json
api-key Necesario. La clave de API se usa para autenticar la solicitud en el servicio Search. Es un valor de cadena único para el servicio. Las solicitudes de obtención de objetos en el servicio deben incluir un campo de clave de API establecido en la clave de administrador (en lugar de una clave de consulta). Puede encontrar la clave de API en el panel del servicio de búsqueda en el Azure Portal.

Cuerpo de la solicitud

Ninguno.

Response

Código de estado: se devuelve "200 OK" para obtener una respuesta correcta.

Ejemplos

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

Puede filtrar la respuesta solo a las propiedades que le interesen. Por ejemplo, si solamente desea una lista de los nombres de índices, use la opción de consulta OData $select :

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

En este caso, la respuesta del ejemplo anterior podría aparecer como sigue:

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

Se trata de una técnica útil para ahorrar ancho de banda, si tiene una gran cantidad de índices en el servicio de búsqueda.

Consulte también

API REST de Azure Cognitive Search
Operaciones de índice (API REST de Azure Cognitive Search)