Retornar todos os clusters do seu projeto.
Use um destes exemplos:
atlas clusters list Liste os clusters retornados pela versão da API de Administrador fixada usada para comandos do cluster L2.
atlas clusters list --autoScalingMode independenteShardScaling Liste somente clusters com dimensionamento de shard independente habilitado.
atlas clusters list --tier FLEX Lista somente clusters flexíveis.
Guia de sinalização: - Use --autoScalingMode independenteShardScaling para clusters de dimensionamento de shards independentes. - Usar --tier FLEX para clusters Flex.
Para usar esse comando, você deve autenticar com uma conta de usuário, uma conta de serviço ou uma chave de API com o role Somente leitura do projeto.
Sintaxe
atlas clusters list [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--autoScalingMode | string | false | Modo em que o cluster é dimensionado. Os valores válidos são clusterWideScaling ou independenteShardScaling. Este valor é padronizado como "clusterWideScaling". |
-h, --help | false | ajuda para lista | |
--limit | int | false | Número de itens por página de resultados, até um máximo de 500. Se você tiver mais de 500 resultados, especifique a opção --page para alterar a página de resultados. Este valor é padronizado para 100. |
--omitCount | false | Sinalizador que indica se a resposta JSON retorna o número total de itens (totalCount) na resposta JSON. | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--page | int | false | Número da página que especifica uma página de resultados. Este valor é padronizado como 1. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--tier | string | false | Camada para cada servidor que contém dados no cluster. Para saber mais sobre camadas do cluster, consulte https://dochub.mongodb.org/core/cluster-tier-atlas. |
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
ID NAME MDB VER STATE <Id> <Name> <MongoDBVersion> <StateName>
Exemplos
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3 and with independent shard scaling mode: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --autoScalingMode independentShardScaling --output json
# Return a JSON-formatted list of all Flex clusters for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --tier FLEX --output json