Obter estatísticas de serviço (API REST de versão prévia)
aplica-se a: 2023-07-01-Preview. Não há mais suporte para essa versão. Atualizar imediatamente para uma versão mais recente.
Importante
2023-07-01-Preview adiciona vectorIndexSize com escopo para um serviço de pesquisa.
2021-04-30-Preview adiciona aliasesCount.
A operação de Estatísticas de Serviço de
As estatísticas sobre a contagem de documentos e o tamanho do armazenamento são coletadas a cada poucos minutos, não em tempo real. Portanto, as estatísticas retornadas por essa API podem não refletir alterações causadas por operações de indexação recentes.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parâmetros de URI
| Parâmetro | Descrição |
|---|---|
| nome do serviço | Necessário. Defina esse valor como o nome exclusivo definido pelo usuário do serviço de pesquisa. O URI da solicitação especifica o nome do índice para o qual as estatísticas devem ser retornadas. |
| api-version | Necessário. Consulte versões de API para obter mais versões. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
| Campos | Descrição |
|---|---|
| Tipo de conteúdo | Necessário. Defina esse valor como application/json |
| chave de api | Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. Obter solicitações no serviço de pesquisa deve incluir um cabeçalho api-key definido como sua chave de administrador (em vez de uma chave de consulta). Consulte Conectar-se ao Azure AI Search usando de autenticação de chave para obter detalhes. |
Corpo da Solicitação
Nenhum.
Resposta
Código de status: "200 OK" é retornado para uma resposta bem-sucedida. O corpo da resposta está no seguinte formato:
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimited document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| Estatística | Tipo | Descrição |
|---|---|---|
| documentCount | Contar | Uma agregação de todos os documentos de todos os índices. As versões iniciais do Azure AI Search impuseram limites de contagem de documentos, mas esse limite não existe mais. A cota é sempre nula indicando que o serviço pode ter contagens ilimitadas de documentos. |
| indexesCount | Contar | O número de índices no serviço de pesquisa. Os índices máximos variam de acordo com a camada, conforme relatado pela cota. |
| indexersCount | Contar | O número de indexadores no serviço de pesquisa. Os indexadores máximos variam de acordo com a camada, conforme relatado pela cota. |
| dataSourcesCount | Contar | O número de fontes de dados no serviço de pesquisa. As fontes de dados máximas variam por camada, conforme relatado pela cota. As fontes de dados máximas são o mesmo número que os indexadores máximos. |
| aliasesCount | Contar | O número de aliases de índice no serviço de pesquisa. O máximo varia por camada, conforme relatado pela cota. |
| synonymMaps | Contar | O número de mapas de sinônimos no serviço de pesquisa. O máximo varia por camada, conforme relatado pela cota. |
| storageSize | Bytes | O uso é o armazenamento de quantidade usado por todos os objetos no serviço. A cota é o armazenamento máximo disponível com base no tamanho e no número de partições configuradas para seu serviço. A cota aumenta e diminui em resposta ao número de partições provisionadas no serviço de pesquisa. O tamanho da partição varia de acordo com a camada. |
| vectorIndexSize | Bytes | Um índice de vetor é uma estrutura interna, um índice de vetor por campo de vetor, conforme definido em um índice de pesquisa. O uso total é relatado em todo o serviço para que você possa monitorar o consumo de espaço vetor em relação ao limite de índice de vetor do serviço de pesquisa. A cota varia por idade do serviço de pesquisa, número de partições e tamanho das partições conforme determinado por camada. |
Para obter mais informações sobre todos os limites, consulte limites de serviço .
Exemplos
Essa API é um plano de dados. Para obter mais informações sobre um serviço, como sua camada ou localização, consulte oda API REST de Gerenciamento de
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}