- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Pause o MongoDB cluster em execução especificado.
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 pause <clusterName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
clusterName | string | true | Nome do cluster a ser pausado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--autoScalingMode | string | false | Modo em que o cluster é dimensionado. Os valores válidos são clusterWideScaling ou independenteShardScaling. Este valor é padronizado como "clusterWideScaling". |
-h, --help | false | ajuda para pausa | |
-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. |
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.
Pausing cluster '<Name>'.
Exemplos
# Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json