Indexes - Get Statistics

Servicio:: Search Service

Versión de la API:: 2026-08-01-preview

Devuelve estadísticas para el índice dado, incluido el recuento de documentos y el uso de almacenamiento.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2026-08-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	El nombre del índice.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	GetIndexStatisticsResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://search.azure.com/.default

Ejemplos

SearchServiceGetIndexStatistics

Solicitud de ejemplo

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/search.stats?api-version=2026-08-01-preview

Respuesta de muestra

status code:: 200

{
  "documentCount": 12,
  "storageSize": 123456,
  "vectorIndexSize": 123456
}

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
GetIndexStatisticsResult	Estadísticas de un índice determinado. Las estadísticas se recopilan periódicamente y no se garantiza que siempre sean up-to-date.

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GetIndexStatisticsResult

Objeto

Estadísticas de un índice determinado. Las estadísticas se recopilan periódicamente y no se garantiza que siempre sean up-to-date.

Nombre	Tipo	Description
documentCount	integer (int64)	El número de documentos en el índice.
storageSize	integer (int64)	La cantidad de almacenamiento en bytes consumido por el índice.
vectorIndexSize	integer (int64)	La cantidad de memoria en bytes consumida por los vectores del índice.