Indexes - Get Statistics

Serviço:

Search Service

Versão da API:

2024-05-01-preview

Devolve estatísticas para o índice especificado, incluindo uma contagem de documentos e a utilização do armazenamento.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexName	path	True	string	O nome do índice para o qual obter estatísticas.
api-version	query	True	string	Versão da API do Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Respostas

Name	Tipo	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetIndexStatistics

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GetIndexStatisticsResult	Estatísticas de um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre atualizadas.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GetIndexStatisticsResult

Estatísticas de um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre atualizadas.

Name	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.