Get Service Statistics - Get Service Statistics

Serviço:

Search Service

Versão da API:

2026-04-01

Obtém estatísticas de nível de serviço para um serviço de pesquisa.

GET {endpoint}/servicestats?api-version=2026-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

Respostas

Name	Tipo	Description
200 OK	SearchServiceStatistics	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

Name	Description
https://search.azure.com/.default

Exemplos

SearchServiceGetS3HDUnlimitedServiceStatistics

SearchServiceGetServiceStatistics

SearchServiceGetS3HDUnlimitedServiceStatistics

Pedido de amostra

HTTP

GET https://exampleservice.search.windows.net/servicestats?api-version=2026-04-01

Resposta da amostra

Código de estado:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000,
    "maxCumulativeIndexerRuntimeSeconds": 86400
  }
}

SearchServiceGetServiceStatistics

Pedido de amostra

HTTP

GET https://exampleservice.search.windows.net/servicestats?api-version=2026-04-01

Resposta da amostra

Código de estado:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definições

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
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.)
ResourceCounter	Representa o uso e a cota de um recurso.
SearchServiceCounters	Representa contadores de recursos e cotas de nível de serviço.
SearchServiceLimits	Representa vários limites de nível de serviço.
SearchServiceStatistics	Resposta de uma solicitação de estatísticas de serviço get. Se for bem-sucedido, inclui contadores e limites de nível de serviço.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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 alvo do erro.

ErrorResponse

Object

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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResourceCounter

Object

Representa o uso e a cota de um recurso.

Name	Tipo	Description
quota	integer (int64)	A cota do valor do recurso.
usage	integer (int64)	O valor de uso do recurso.

SearchServiceCounters

Object

Representa contadores de recursos e cotas de nível de serviço.

Name	Tipo	Description
aliasesCount	ResourceCounter	Número total de aliases.
dataSourcesCount	ResourceCounter	Número total de fontes de dados.
documentCount	ResourceCounter	Número total de documentos em todos os índices do serviço.
indexersCount	ResourceCounter	Número total de indexadores.
indexesCount	ResourceCounter	Número total de índices.
skillsetCount	ResourceCounter	Número total de competências.
storageSize	ResourceCounter	Tamanho total do armazenamento usado em bytes.
synonymMaps	ResourceCounter	Número total de mapas de sinónimos.
vectorIndexSize	ResourceCounter	Consumo total de memória de todos os índices vetoriais dentro do serviço, em bytes.

SearchServiceLimits

Object

Representa vários limites de nível de serviço.

Name	Tipo	Description
maxComplexCollectionFieldsPerIndex	integer (int32)	O número máximo de campos do tipo Collection(Edm.ComplexType) permitido em um índice.
maxComplexObjectsInCollectionsPerDocument	integer (int32)	O número máximo de objetos em coleções complexas permitido por documento.
maxCumulativeIndexerRuntimeSeconds	integer (int64)	O tempo máximo acumulado de execução do indexador em segundos permitido para o serviço.
maxFieldNestingDepthPerIndex	integer (int32)	A profundidade máxima que você pode aninhar subcampos em um índice, incluindo o campo complexo de nível superior. Por exemplo, a/b/c tem uma profundidade de aninhamento de 3.
maxFieldsPerIndex	integer (int32)	O máximo de campos permitidos por índice.
maxStoragePerIndex	integer (int64)	A quantidade máxima de armazenamento em bytes permitida por índice.

SearchServiceStatistics

Object

Resposta de uma solicitação de estatísticas de serviço get. Se for bem-sucedido, inclui contadores e limites de nível de serviço.

Name	Tipo	Description
counters	SearchServiceCounters	Contadores de recursos de nível de serviço.
limits	SearchServiceLimits	Limites gerais de nível de serviço.