Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ /

lista do cluster do Atlas

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Retornar todos os clusters do seu projeto.

Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.

Sintaxe do comando
atlas clusters list [options]
Nome
Tipo
Obrigatório
Descrição
-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.
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.

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>
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json

Voltar

criar