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

projetos do atlas descrever

Nesta página

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

Retornar os detalhes do projeto especificado.

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 projects describe <ID> [options]
Nome
Tipo
Obrigatório
Descrição

ID

string

true

Sequência única de 24 dígitos que identifica o projeto.

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.

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
<Id> <Name>
# Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas projects describe 5e2211c17a3e5a48f5497de3 --output json

Voltar

excluir