atlas api clusters listClusters

O suporte do Atlas CLI para executar comandos com o está em pré-visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: retorna os detalhes de todos os clusters do projeto específico ao qual você tem acesso.

Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters com shards de tamanhos assimétricos. Para usar esse recurso, a chave de API solicitante deve ter a função de "somente leitura" do projeto. Essa funcionalidade não está disponível para clusters sem servidor. Este comando está invocando o endpoint com OperationID: 'listClusters'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters

Sintaxe

Sintaxe do comando

atlas api clusters listClusters [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--groupId	string	true	string exclusiva de dígitos hexadecimais 24que identifica seu projeto
-h, --help		false	ajuda para listClusters
--includeCount		false	sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta
--includeDeletedWithRetainedBackups		false	sinalizador que indica se clusters com backups retidos devem ser retornados
--itemsPerPage	int	false	número de itens que a resposta retorna por página
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	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)
--pageNum	int	false	número da página que exibe o conjunto atual do total de objetos que a resposta retorna
--pretty		false	sinalizador que indica se o corpo da resposta deve estar no formato de impressão bonita
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2023-02-01", "2024-08-05"], tem como padrão a versão mais recente ou o valor de configuração dos perfis api_version se definido Esse valor padrão é "2024-08-05".

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.

Voltar

listCloudProviderRegions

listClustersForAllProjects