Indexes - Get Statistics

Servicio:

Search Service

Versión de la API:

2024-05-01-preview

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

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	Nombre del índice para el que se van a recuperar las estadísticas.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceGetIndexStatistics

Solicitud de ejemplo

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-05-01-preview

Respuesta de muestra

status code:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GetIndexStatisticsResult	Estadísticas de un índice determinado. Las estadísticas se recopilan periódicamente y no se garantiza que siempre estén actualizadas.

ErrorAdditionalInfo

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

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

ErrorDetail

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GetIndexStatisticsResult

Estadísticas de un índice determinado. Las estadísticas se recopilan periódicamente y no se garantiza que siempre estén actualizadas.

Nombre	Tipo	Description
documentCount	integer	Número de documentos del índice.
storageSize	integer	Cantidad de almacenamiento en bytes consumido por el índice.
vectorIndexSize	integer	Cantidad de memoria en bytes consumida por vectores en el índice.