Visualização pública: forneça feedback em: retorna os detalhes de todos os clusters do projeto específico ao qual você tem acesso.
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 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 listFlexClusters para clusters Flex .
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api clusters listClusters [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--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 listClusters | |
--includeCount | false | Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. | |
--includeDeletedWithRetainedBackups | false | Sinalizador que indica se clusters com backups retidos devem ser retornados. | |
--itemsPerPage | int | false | Número de itens que a resposta retorna por página. |
--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) |
--pageNum | int | false | Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>. | |
--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
Retorna todos os clusters no projeto especificado
Execute o comando abaixo.
atlas api clusters listClusters --version 2024-08-05 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false