Visualização pública: forneça comentários: retorna os detalhes de um cluster no projeto especificado.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos 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 endpoint da API fornecido.
Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters com fragmentos de tamanho assimétrico. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto. Este recurso 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 clusters Flex .
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api clusters getCluster [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Etiqueta legível para humanos que identifica este cluster. |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
-h, --help | false | ajuda para getCluster | |
-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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--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. |
Exemplos
atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --groupId [your-project-id]