atlas backups Schedule update
修改你的项目为指定集群的备份安排。
备份安排定义了 MongoDB 何时拍摄安排快照以及存储这些快照的时间。
要使用此命令，您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
atlas backups schedule update [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--autoExport | false | 启用将云备份快照自动导出到 Amazon Web Services 存储桶的标记。 与 --noAutoExport、--file 互斥。 | |
--clusterName | 字符串 | true | 集群名称。 要了解详情，请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
--exportBucketId | 字符串 | false | Atlas 分配给存储桶的唯一标识符。 与 --文件 互斥。 |
--exportFrequencyType | 字符串 | false | 与导出策略相关的频率。 值可以是每天、每周或每月。 与 --文件 互斥。 |
-f, --file | 字符串 | false | 定义备份计划设置的可选 JSON 配置文件的路径。 要了解 Atlas CLI 的云备份配置文件，请参阅 https://dochub.mongodb.org/core/cloud-backup-config-file。 与 --exportBucketId、--exportFrequencyType、--referenceHourOfDay、--referenceMinuteOfHour、--restoreWindowDays、--autoExport、--noAutoExport、--updateSnapshots、--noUpdateSnapshots、--useOrgAndGroupNamesInExportPrefix、--noUseOrgAndGroupNamesInExportPrefix、--policy 互斥。 |
-h，--help | false | 更新帮助 | |
--noAutoExport | false | 标志，用于禁用将云备份快照自动导出到 AWS 存储桶。 与 --autoExport、文件 互斥。 | |
--noUpdateSnapshots | false | 标志，用于禁用将更新的备份策略中的保留更改应用于 Atlas 之前拍摄的快照。 与 --updateSnapshots、文件 互斥。 | |
--noUseOrgAndGroupNamesInExportPrefix | false | 标记，禁止在 Atlas 完成快照导出后上传到 S3 存储桶的元数据文件的路径中使用组织和项目名称而不是组织和项目 UUID。 与 --useOrgAndGroupNamesInExportPrefix、文件 互斥。 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--policy | 字符串数组 | false | 包含所需更新备份策略中每个备份策略项的文档的数组。 必须以以下格式指定：'--policy policyID,policyItemID,FrequencyType,FrequencyIntervalNumber,retentionUnit,retentionValue'。 与 --文件 互斥。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--referenceHourOfDay | int | false | 使用 24 小时制安排快照的时间。接受的值介于 0 到 23（含）之间。 与 --文件 互斥。 |
--referenceMinuteOfHour | int | false | 安排快照的小时中的分钟。 接受的值介于 0 到 59 之间（含）。 与 --文件 互斥。 |
--restoreWindowDays | int | false | 使用“持续云备份”精度可以恢复到的时间倒回天数。 必须是非零的正整数。 仅适用于连续云备份。 与 --文件 互斥。 |
--updateSnapshots | false | 标记，用于将更新的备份策略中的保留更改应用于 Atlas 之前拍摄的快照。 与 --noUpdateSnapshots、文件 互斥。 | |
--useOrgAndGroupNamesInExportPrefix | false | 标记，允许在 Atlas 完成快照导出后上传到 S3 存储桶的元数据文件的路径中使用组织和项目名称，而不是组织和项目 UUID。 与 --noUseOrgAndGroupNamesInExportPrefix、文件 互斥。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
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