Indexes - Get Statistics

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

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

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
endpoint
path True

string (uri)

A URL do ponto de extremidade do serviço de pesquisa.

indexName
path True

string

O nome do índice.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Nome Obrigatório Tipo Descrição
x-ms-client-request-id

string (uuid)

Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Accept

Accept

O cabeçalho Accept.

Respostas

Nome Tipo Descrição
200 OK

GetIndexStatisticsResult

O pedido foi bem-sucedido.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Nome Descrição
https://search.azure.com/.default

Exemplos

SearchServiceGetIndexStatistics

Pedido de amostra

GET https://typespecstableexampleservice.search.windows.net/indexes('stable-test')/search.stats?api-version=2026-10-01


Resposta da amostra

{
  "documentCount": 12,
  "storageSize": 123456,
  "vectorIndexSize": 123456
}

Definições

Nome Descrição
Accept

O cabeçalho Accept.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

GetIndexStatisticsResult

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

Accept

O cabeçalho Accept.

Valor Descrição
application/json;odata.metadata=minimal

ErrorAdditionalInfo

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

Nome Tipo Descrição
info

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Descrição
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 alvo do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Nome Tipo Descrição
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.

Nome Tipo Descrição
documentCount

integer (int64)

O número de documentos no índice.

storageSize

integer (int64)

A quantidade de armazenamento em bytes consumida pelo índice.

vectorIndexSize

integer (int64)

A quantidade de memória em bytes consumida por vetores no índice.