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

atualização da programação de backups do Atlas

Nesta página

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

Modifique o agendamento de backup do cluster especificado para seu projeto.

O agendamento de backup define quando o MongoDB realiza snapshots programados e por quanto tempo os armazena.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.

Sintaxe do comando
atlas backups schedule update [options]
Nome
Tipo
Obrigatório
Descrição
--autoExport
false

Sinalizador que permite a exportação automática de snapshots de backup em cloud para o bucket da Amazon Web Services.

Mutuamente exclusivo com --noAutoExport, --file.

--clusterName
string
true
Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api.
--exportBucketId
string
false

Identificador único que o Atlas atribui ao bucket.

Mutuamente exclusivo com --file.

--exportFrequencyType
string
false

Frequência associada à política de exportação. O valor pode ser diário, semanal ou mensal.

Mutuamente exclusivo com --file.

-f, --file
string
false

Caminho para um arquivo de configuração JSON opcional que define as configurações do agendamento de backup. Para saber mais sobre o arquivo de configuração de backup em nuvem para Atlas CLI, consulte https://dochub.mongodb.org/core/cloud-backup-config-file.

Mutuamente exclusivo com --exportBucketId, --exportFrequencyType, --referenceHourOfDay, --referenceMinuteOfHour, --restoreWindowDays, --autoExport, --noAutoExport, --updateSnapshots, --noUpdateSnapshots, --useOrgAndGroupNamesInExportPrefix, --noUseOrgAndGroupNamesInExportPrefix, --política .

-h, --help
false
ajuda para atualização
--noAutoExport
false

Sinalizador que desabilita a exportação automática de snapshots de backup em nuvem para o bucket da Amazon Web Services.

Mutuamente exclusivo com --autoExport, --file.

--noUpdateSnapshots
false

Sinalizador que desabilita a aplicação das alterações de retenção na política de backup atualizada a snapshots que o Atlas tirou anteriormente.

Mutuamente exclusivo com --updateSnapshots, --file.

--noUseOrgAndGroupNamesInExportPrefix
false

Sinalizador que desabilita o uso de nomes de organização e projeto em vez de UUIDs de organização e projeto no caminho para os arquivos de metadados que o Atlas carrega no seu bucket do S3 após concluir a exportação dos snapshots.

Mutuamente exclusivo com --useOrgAndGroupNamesInExportPrefix, --file.

-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.
--policy
array de strings
false

Array contendo um documento para cada item da política de backup na política de backup atualizada desejada. Você deve especificá-lo em um formato: '--Política PolicyID,PolicyItemID,frequencyType,frequencyIntervalNumber,retentionUnit,retentionValue'.

Mutuamente exclusivo com --file.

--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.
--referenceHourOfDay
int
false

Hora do dia para agendar snapshots usando um relógio de 24 horas. Os valores aceitos estão entre 0 e 23 inclusive.

Mutuamente exclusivo com --file.

--referenceMinuteOfHour
int
false

Minuto da hora para agendar snapshots. Os valores aceitos estão entre 0 e 59 inclusive.

Mutuamente exclusivo com --file.

--restoreWindowDays
int
false

Número de dias no tempo para o qual você pode restaurar com precisão do Continuous cloud Backup. Deve ser um número inteiro positivo, diferente de zero. Aplica-se apenas a backups contínuos na cloud.

Mutuamente exclusivo com --file.

--updateSnapshots
false

Sinalizador que permite aplicar as alterações de retenção na política de backup atualizada a snapshots que o Atlas tirou anteriormente.

Mutuamente exclusivo com --noUpdateSnapshots, --file.

--useOrgAndGroupNamesInExportPrefix
false

Sinalizador que permite o uso de nomes de organização e projeto em vez de UUIDs de organização e projeto no caminho para os arquivos de metadados que o Atlas carrega no seu bucket do S3 após concluir a exportação dos snapshots.

Mutuamente exclusivo com --noUseOrgAndGroupNamesInExportPrefix, --file.

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.

Snapshot backup policy for cluster '<ClusterName>' updated.
# Update a snapshot backup policy for a cluster named Cluster0 to back up snapshots every 6 hours and, retain for 7 days, and update retention of previously-taken snapshots:
atlas backup schedule update --clusterName Cluster0 --updateSnapshots --policy 62da8faac84a2721e448d767,62da8faac84a2721e448d768,hourly,6,days,7
# Update a snapshot backup policy for a cluster named Cluster0 to export snapshots monthly to an S3 bucket:
atlas backup schedule update --clusterName Cluster0 --exportBucketId 62c569f85b7a381c093cc539 --exportFrequencyType monthly

Voltar

descrever