Get Service Statistics - Get Service Statistics

Referência

Service:: Search Service

API Version:: 2023-11-01

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

GET {endpoint}/servicestats?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
api-version	query	True	string	Versão da API de 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	ServiceStatistics
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchServiceGetServiceStatistics

Sample Request

HTTP

GET https://myservice.search.windows.net/servicestats?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "counters": {
    "documentCount": {
      "usage": 7093,
      "quota": 10000
    },
    "indexesCount": {
      "usage": 3,
      "quota": 3
    },
    "indexersCount": {
      "usage": 3,
      "quota": 3
    },
    "dataSourcesCount": {
      "usage": 1,
      "quota": 3
    },
    "storageSize": {
      "usage": 914529,
      "quota": 52428800
    },
    "synonymMaps": {
      "usage": 2,
      "quota": 3
    },
    "vectorIndexSize": {
      "usage": 123456,
      "quota": 26214400
    }
  },
  "limits": {
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 100,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definições

Name	Description
ResourceCounter	Representa a utilização e a quota de um recurso.
SearchError	Descreve uma condição de erro para a API.
ServiceCounters	Representa contadores de recursos e quotas ao nível do serviço.
ServiceLimits	Representa vários limites de nível de serviço.
ServiceStatistics	Resposta de um pedido obter estatísticas de serviço. Se for bem-sucedido, inclui contadores e limites de nível de serviço.

ResourceCounter

Representa a utilização e a quota de um recurso.

Name	Tipo	Description
quota	integer	A quota de montante do recurso.
usage	integer	A quantidade de utilização de recursos.

SearchError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message	string	Uma representação legível por humanos do erro.

ServiceCounters

Representa contadores de recursos e quotas ao nível do serviço.

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

ServiceLimits

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

Name	Tipo	Description
maxComplexCollectionFieldsPerIndex	integer	O número máximo de campos do tipo Coleção(Edm.ComplexType) permitido num índice.
maxComplexObjectsInCollectionsPerDocument	integer	O número máximo de objetos em coleções complexas permitidas por documento.
maxFieldNestingDepthPerIndex	integer	A profundidade máxima que pode aninhar sub-campos num índice, incluindo o campo complexo de nível superior. Por exemplo, a/b/c tem uma profundidade de aninhamento de 3.
maxFieldsPerIndex	integer	Os campos máximos permitidos por índice.

ServiceStatistics

Resposta de um pedido obter estatísticas de serviço. Se for bem-sucedido, inclui contadores e limites de nível de serviço.

Name	Tipo	Description
counters	ServiceCounters	Contadores de recursos ao nível do serviço.
limits	ServiceLimits	Limites gerais de nível de serviço.

Partilhar via