atlas api clusters getCluster

: Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: Retorna os detalhes de um cluster no projeto especificado.

Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters com shards de tamanhos assimétricos. Para usar esse recurso, a chave de API solicitante deve ter a função de "somente leitura" do projeto. Essa funcionalidade não está disponível para clusters sem servidor. Esse endpoint também pode ser usado em clusters Flex que foram criados usando o endpoint createCluster ou em antigos clusters M2/M5 que foram migrados para clusters Flex até 2026 de janeiro. Em vez disso, use o endpoint getFlexCluster para Flex clusters . Este comando está invocando o endpoint com OperationID: 'getCluster'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster

Sintaxe

Sintaxe do comando

atlas api clusters getCluster [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--clusterName	string	true	etiqueta legível por humanos que identifica este cluster
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--groupId	string	true	string exclusiva de dígitos hexadecimais 24que identifica seu projeto
-h, --help		false	ajuda para getCluster
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	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)
--pretty		false	sinalizador que indica se o corpo da resposta deve estar no formato de impressão bonita
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2023-02-01", "2024-08-05"], tem como padrão a versão mais recente ou o valor de configuração dos perfis api_version se definido Esse valor padrão é "2024-08-05".

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.

Voltar

excluir cluster

getClusterAdvancedConfiguration