Enumeración de índices (API REST de Azure AI Search)
La operación List Indexes devuelve una lista de los índices que se encuentran actualmente en azure AI servicio 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 | Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes get para una definición de objeto deben incluir un campo de clave de API establecido en la clave de administración (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información. |
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 a solo las propiedades que le interesan. 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.