Pause o MongoDB cluster em execução 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 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.
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