Retorna os detalhes de um Atlas Ephemeral cluster.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do ponto de extremidade da API fornecido.
Para saber mais sobre clusters efêmeros, consulte Criar um cluster efêmero do Atlas na documentação do MongoDB Atlas .
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-getephemeralcluster. da API Atlas
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api ephemeralClusters getEphemeralCluster [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterId | string | true | ID exclusivo do cluster efêmero a ser pesquisado. |
-h, --help | false | ajuda para getEphemeralCluster | |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | string | false | no qual gravar a saÃda da API. Esse sinalizador é necessário quando a saÃda de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--version | string | false | Versão da API a ser usada ao chamar os pontos de extremidade da API do Atlas [opções: "preview"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Esse valor tem como padrão "preview". |
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. |