Obtener índice (API REST de Azure AI Search)
La operación Obtener índice obtiene la definición de índice de Azure AI Search.
GET https://[service name].search.windows.net/indexes/[index name]?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. |
| nombre de índice | Necesario. El URI de solicitud especifica el nombre del índice que se va a devolver. |
| api-version | Necesario. Consulte Versiones de API para obtener una lista de las versiones admitidas. |
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. Si usa claves de API, especifique una clave de administrador (en lugar de una clave de consulta) para devolver información de objeto desde el servicio de búsqueda. 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. Consulte el ejemplo de solicitud JSON en Create Index (API REST de Azure AI Search) para obtener un ejemplo de la carga de respuesta. El cuerpo de la respuesta Obtener índice y los cuerpos de respuesta Crear índice son todos del mismo formato.