Indexes - Get Statistics

Serviço:

Search Service

Versão da API:

2024-07-01

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

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

Parâmetros do URI

Name	Em	Necessá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 do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de rastreamento enviado com a solicitação para ajudar com a 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-07-01

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GetIndexStatisticsResult	Estatísticas para um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre up-todata.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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 de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GetIndexStatisticsResult

Estatísticas para um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre up-todata.

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