Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

cluster do Atlas onlineArchives pausa

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Pause o Atlas Online Archive especificado para seu cluster.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a função de "administrador de acesso a dados do projeto".

Sintaxe do comando
atlas clusters onlineArchives pause <archiveId> [options]
Nome
Tipo
Obrigatório
Descrição

archiveId

string

true

Identificador único do Atlas Online Archive a ser pausado.

Nome
Tipo
Obrigatório
Descrição

--clusterName

string

true

Nome do cluster.

-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.

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.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

Online archive '<Id>' paused.
# Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json

Voltar

Lista