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

descrição sem servidor do atlas

Nesta página

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

Retorne uma instância sem servidor no 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 serverless describe <instanceName> [options]
Nome
Tipo
Obrigatório
Descrição

instanceName

string

true

Etiqueta legível por humanos que identifica sua instância sem servidor.

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.

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 the JSON-formatted details for the serverlessInstance named myInstance in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas serverless describe myInstance --projectId 5e2211c17a3e5a48f5497de3

Voltar

excluir