atlas api clusters updateCluster

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.

Visualização pública: forneça comentários em: Atualiza os detalhes de um cluster no projeto especificado .

Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Este recurso pode atualizar clusters com shards de tamanhos assimétricos. Para atualizar a proteção de encerramento de um cluster, a chave de API solicitante deve ter a role de proprietário do projeto. Para todas as outras atualizações, a chave de API solicitante deve ter a role de gerenciador de cluster de projeto. Não é possível modificar um cluster pausado (pausado : true). Você deve chamar esse endpoint para definir pausado : false. Depois que esse endpoint responder com paused : false, você poderá chamá-lo novamente com as alterações que deseja fazer no cluster. Essa funcionalidade não está disponível para clusters sem servidor.

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/ operation/updateCluster.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api clusters updateCluster [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--clusterName	string	true	Etiqueta legível por humanos que identifica o 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.
--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 updateCluster
--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 <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", "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

Atualiza o cluster para aumentar o tamanho do disco para 20GB e aumentar a contagem de nós para 5

Crie o arquivo abaixo e salve-o como payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "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 updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false

Voltar

unpinFeatureCompatibilityVersion

updateClusterAdvancedConfiguration