Obtención de estadísticas de índice (API REST de Azure AI Search)

La operación Obtener estadísticas de índice devuelve de Azure AI Search un recuento de documentos para el índice actual, además del uso del almacenamiento. También puede obtener esta información desde el portal.

Nota

Se recopilan estadísticas del tamaño de almacenamiento y el número de documento cada pocos minutos; es decir, no se hace en tiempo real. Por lo tanto, es posible que las estadísticas que devuelve esta API no reflejen los cambios causados por operaciones de indexación recientes.

GET https://[service name].search.windows.net/indexes/[index name]/stats?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 para el que se deben devolver las estadísticas.
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. El cuerpo de la respuesta está en el formato siguiente:

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes)  
}  

Consulte también