Indexes - Get Statistics

Serviço:

Search Service

Versão da API:

2023-10-01-Preview

Retorna estatísticas para o índice especificado, incluindo uma contagem de documentos e o uso de armazenamento.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-10-01-Preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice para o qual recuperar estatísticas.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchServiceGetIndexStatistics

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
GetIndexStatisticsResult	Estatísticas para um determinado índice. As estatísticas são coletadas periodicamente e não têm garantia de estar sempre atualizadas.
SearchError	Descreve uma condição de erro para a API.

GetIndexStatisticsResult

Estatísticas para um determinado índice. As estatísticas são coletadas periodicamente e não têm garantia de estar sempre atualizadas.

Nome	Tipo	Description
documentCount	integer	O número de documentos no índice.
storageSize	integer	A quantidade de armazenamento em bytes consumidos pelo índice.
vectorIndexSize	integer	A quantidade de memória em bytes consumidos por vetores no índice.

SearchError

Descreve uma condição de erro para a API.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível pelo homem do erro.