Visualização pública: forneça comentários: cria 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. Esse recurso pode criar clusters com fragmentos de tamanho assimétrico. Cada projeto suporta até 25 implantações de banco de dados. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto. Este recurso não está disponível para clusters sem servidor.
Observe que usar um instanceSize de M2 ou M5 criará um cluster Flex. O suporte para o tamanho da instância M2 ou M5 será descontinuado em janeiro de 2026. Recomendamos usar a API createFlexCluster para essas configurações daqui para frente.
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-createcluster.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api clusters createCluster [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. |
--file | string | false | caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos. |
--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 createCluster | |
-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", "2024-10-23"], tem como padrão a versão mais recente ou o valor de configuração dos perfis api_version se definido Este valor é padronizado como "2024-10-23". |
-w, --watch | false | Sinalizador que indica se o comando deve ser observado até que ele conclua a execução ou o aviso expire. | |
--watchTimeout | int | false | Tempo em segundos até que um relógio expire. Após o tempo limite de observação, a CLI não observa mais o comando. |
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
cluster
Crie o arquivo abaixo e salve-o como payload.json
{ "clusterType": "SHARDED", "name": "myCluster", "replicationSpecs": [ { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M50", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M50", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" }, { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M30", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" } ] }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api clusters createCluster --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8
cluster
Crie o arquivo abaixo e salve-o como payload.json
{ "clusterType": "SHARDED", "name": "myCluster", "replicationSpecs": [ { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M40", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M60", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M60", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M60", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" }, { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M40", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M30", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M60", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" } ] }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api clusters createCluster --version 2024-10-23 --groupId 32b6e34b3d91647abb20e7b8
Cria um novo cluster de conjunto de réplicas M10 na região leste dos EUA do Amazon Web Services executando o MongoDB 6.0
Crie o arquivo abaixo e salve-o como payload.json
{ "clusterType": "REPLICASET", "name": "MyCluster", "replicationSpecs": [ { "regionConfigs": [ { "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M10", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "regionName": "US_EAST_1" } ] } ] }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api clusters createCluster --version 2024-10-23 --groupId [your-project-id]