Retorna as medições de um banco de dados para o host especificado do projeto especificado .
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Retorna o espaço de armazenamento no disco do banco de dados com base na saída do comando MongoDB dbStats. Para calcular algumas séries de métricas, o Atlas obtém a taxa entre cada dois pontos adjacentes. Para esta série de métricas, o primeiro ponto de dados tem um valor nulo, pois o Atlas não pode calcular uma taxa para o primeiro ponto de dados dado o intervalo de tempo da query. O Atlas recupera métricas do banco de dados a cada 20 minutos, mas reduz a frequência quando necessário para otimizar o desempenho do banco de dados . Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/ operation-getgroupprocessdatabasemeasurements.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api monitoringAndLogs getDatabaseMeasurements [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--databaseName | string | true | Rótulo legível por humanos que identifica o banco de dados ao qual o processo MongoDB especificado atende. |
--end | string | false | Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período. |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--granularity | string | true | Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
-h, --help | false | ajuda para getDatabaseMeasurements | |
--m | m | false | Um ou mais tipos de medição a serem solicitados para esse processo do MongoDB . Se omitido, o recurso retorna todas as medições. Para especificar valores múltiplos para m, repita o parâmetro |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--period | string | false | Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término. |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--processId | mongod | true | Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB . O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou |
--start | string | false | Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017