Obtener estadísticas del servicio (API REST de versión preliminar)
Se aplica a: 2023-07-01-Preview, 2021-04-30-Preview
Importante
2023-07-01-Preview agrega vectorIndexSize con ámbito a un servicio de búsqueda.
2021-04-30-Preview agrega aliasesCount.
La operación Estadísticas de servicio devuelve el número y el tipo de objetos del servicio, el máximo permitido para cada tipo de objeto según el nivel de servicio, el almacenamiento real y máximo, y otros límites que varían según el nivel. Esta solicitud extrae información del servicio para que no tenga que buscar ni calcular los límites del servicio.
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/servicestats?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. Establezca este valor en el nombre único definido por el usuario del servicio de búsqueda. El URI de solicitud especifica el nombre del índice para el que se deben devolver las estadísticas. |
| api-version | Necesario. La versión preliminar actual es 2023-07-01-Preview. 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. Establezca este valor 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 en el servicio de búsqueda deben incluir un api-key encabezado establecido en la clave de administrador (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:
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimited document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| Estadísticas | Tipo | Descripción |
|---|---|---|
| documentCount | Count | Una agregación de todos los documentos de todos los índices. Las versiones anteriores de Azure AI Search aplicaron límites de recuento de documentos, pero ese límite ya no existe. La cuota siempre es null que indica que el servicio puede tener recuentos ilimitados de documentos. |
| indexesCount | Count | Número de índices en el servicio de búsqueda. Los índices máximos varían según el nivel, según lo notificado por la cuota. |
| indexersCount | Count | Número de indizadores en el servicio de búsqueda. Los indexadores máximos varían según el nivel, según lo notificado por la cuota. |
| dataSourcesCount | Count | Número de orígenes de datos en el servicio de búsqueda. Los orígenes de datos máximos varían según el nivel, según lo notificado por la cuota. Los orígenes de datos máximos son el mismo número que los indexadores máximos. |
| aliasesCount | Count | Número de alias de índice en el servicio de búsqueda. El máximo varía según el nivel, según lo notificado por la cuota. |
| synonymMaps | Count | Número de asignaciones de sinónimos en el servicio de búsqueda. El máximo varía según el nivel, según lo notificado por la cuota. |
| storageSize | Bytes | El uso es la cantidad de almacenamiento que usan todos los objetos del servicio. La cuota es el almacenamiento máximo disponible en función del tamaño y el número de particiones configuradas para el servicio. La cuota aumenta y disminuye en respuesta al número de particiones aprovisionadas en el servicio de búsqueda. El tamaño de la partición varía según el nivel. |
| vectorIndexSize | Bytes | Un índice vectorial es una estructura interna, un índice de vector por campo vectorial tal y como se define en un índice de búsqueda. El uso total se notifica en el servicio para que pueda supervisar el consumo de espacio vectorial en relación con el límite de índice de vectores del servicio de búsqueda. La cuota varía según la antigüedad del servicio de búsqueda, el número de particiones y el tamaño de las particiones según lo determine el nivel. |
Para obtener más información sobre todos los límites, consulte Límites de servicio .
Ejemplos
Esta API es el plano de datos. Para obtener más información sobre un servicio, como su nivel o ubicación, consulte la API REST de administración.
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}