cluster do Atlas descrever
Retorne os detalhes do cluster especificado para 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
atlas clusters describe <clusterName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
clusterName | string | true | Nome do cluster a ser recuperado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para descrever | |
-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. |
--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. |
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 the JSON-formatted details for the cluster named myCluster: atlas clusters describe myCluster --output json