Modifique as configurações do cluster especificado.
Visualização pública: o subcomando atlas api, 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 feedback em https://feedback.mongodb.com/ fóruns/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.
Você pode especificar modificações em um arquivo de configuração JSON com o sinalizador --file.
Você não pode alterar o nome do cluster ou fazer downgrade da versão MongoDB do seu cluster.
Você só pode atualizar um conjunto de réplicas para um cluster de shard único; você não pode atualizar um conjunto de réplicas em um cluster multifragmentado. Para saber mais, consulte https://www.mongodb.com/pt-br/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster e https://www.mongodb.com/pt-br/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster.
Nota de descontinuação: as camadas M2 e M5 estão agora descontinuadas; ao selecionar M2 ou M5, será criada uma camada FLEX. Para o guia de migração, visite: https://dochub.mongodb.org/core/flex-migration.n
Para utilizar este comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Gerenciador de cluster do projeto. O Atlas suporta este comando apenas para clusters M10+
Sintaxe
atlas clusters update [clusterName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
clusterName | string | false | Nome do cluster a ser atualizado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--disableTerminationProtection | false | Desabilita a proteção contra encerramento para o cluster. Você pode excluir um cluster com a proteção de encerramento desabilitada. Mutuamente exclusivo com --enableTerminationProtection, --file. | |
--diskSizeGB | float | false | Capacidade, em gigabytes, do volume raiz do host. Mutuamente exclusivo com --file. |
--enableTerminationProtection | false | Habilita a proteção contra encerramento para seu cluster. Não é possível excluir um cluster com a proteção de encerramento habilitada. Mutuamente exclusivo com --disableTerminationProtection, --file. | |
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações do agrupamento. Observação: os campos não suportados no arquivo JSON são ignorados. Para saber mais sobre arquivos de configuração de cluster para Atlas CLI, consulte https://dochub.mongodb.org/core/cluster-config-file-atlascli. Mutuamente exclusivo com --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag. |
-h, --help | false | ajuda para atualização | |
--mdbVersion | string | false | Versão MongoDB principal do cluster. |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--tag | chave=valor | false | Lista que contém pares de valor-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar o cluster. A transferência desse sinalizador substitui os dados preexistentes. Mutuamente exclusivo com --file. |
--tier | string | false | Camada para cada servidor que contém dados no cluster. Para saber mais sobre camadas de cluster, consulte https://dochub.mongodb.org/core/cluster-tier-atlas. Mutuamente exclusivo com --file. |
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Updating cluster '<Name>'.
Exemplos
# Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50
# Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1
# Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag =
# Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20
# Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0
# Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json