Menu Docs
Página inicial do Docs
/ /

atlas api collectionLevelMetrics listCollStatMeasurements

Obtenha uma lista das medidas em nível de cluster de latência da Coll Stats para o namespace 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.

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

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe do comando
atlas api collectionLevelMetrics listCollStatMeasurements [options]
Nome
Tipo
Obrigatório
Descrição

--clusterName

string

true

Rótulo legível por humanos que identifica o cluster para o qual recuperar métricas.

--clusterView

string

true

Etiqueta legível por humanos que identifica a topologia do cluster para a qual recuperar as métricas.

--collectionName

string

true

Etiqueta legível para humanos que identifica a collection.

--databaseName

string

true

Rótulo legível por humanos que identifica o banco de dados.

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

--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 listCollStatMeasurements

--metrics

array de strings

false

Lista que contém as métricas que você deseja recuperar para a série de dados associada. Se você não definir esse parâmetro, esse recurso retornará séries de dados para todas as métricas de Latência de Coll Stats.

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

--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-11-15"], 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-11a15".

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

atlas api collectionLevelMetrics listCollStatMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H

Voltar

getProcessNamespaces

Nesta página