Indexes - Get Statistics

Service:

Search Service

API Version:

2023-11-01

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=2023-11-01

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	SearchError	Respuesta de error.

Ejemplos

SearchServiceGetIndexStatistics

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definiciones

Nombre	Description
GetIndexStatisticsResult	Estadísticas de un índice determinado. Las estadísticas se recopilan periódicamente y no se garantiza que siempre estén actualizadas.
SearchError	Describe una condición de error para la API.

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.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.