Estatísticas de Serviço em Azure Cognitive Search (API REST de visualização)

Versão da API: 2021-04-30-Preview

Importante

Esta visualização adiciona um aliasesCount às estatísticas de serviço existentes.

A operação de Estatísticas de Serviço retorna o número e o tipo de objetos em seu serviço, o máximo permitido para cada tipo de objeto, considerando a camada de serviço, o armazenamento real e máximo e outros limites que variam de acordo com a camada. Essa solicitação extrai informações do serviço para que você não precise pesquisar nem calcular limites de serviço.

As estatísticas de tamanho de armazenamento e contagem de documentos são coletadas a cada poucos minutos, não em tempo real. Portanto, talvez as estatísticas retornadas por essa API não reflitam as 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 Obrigatórios. Defina isso 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 Obrigatórios. A versão estável atual é api-version=2020-06-30. Consulte versões da API para obter mais versões.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais

Campos Descrição
Tipo de conteúdo Obrigatórios. Defina-o como application/json
chave de API Obrigatórios. A chave de api é usada para autenticar a solicitação no serviço Pesquisa. É um valor de cadeia de caracteres exclusivo de seu serviço. Obter solicitações de informações do sistema deve incluir um campo de chave de api definido como sua chave de administração (em vez de uma chave de consulta). Você pode encontrar a chave de API no painel do serviço de pesquisa no portal do Azure.

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 unlimitied 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
        }
    },
    "limits": {
        "maxFieldsPerIndex": number,
        "maxIndexerRunTime": string,
        "maxFileExtractionSize": number,
        "maxFileContentCharactersToExtract": number,
        "maxFieldNestingDepthPerIndex": number,
        "maxComplexCollectionFieldsPerIndex": number,
        "maxComplexObjectsInCollectionsPerDocument": number
    }
}

Exemplos

{
    "@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": 15
        }
    },
    "limits": {
        "maxFieldsPerIndex": 1000,
        "maxIndexerRunTime": "P1D",
        "maxFileExtractionSize": 16777216,
        "maxFileContentCharactersToExtract": 65536,
        "maxFieldNestingDepthPerIndex": 10,
        "maxComplexCollectionFieldsPerIndex": 40,
        "maxComplexObjectsInCollectionsPerDocument": 3000
    }
}

Confira também