调用ModifyBackupPolicy修改实例的备份策略_云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

修改MongoDB实例的备份策略。

接口说明

异地备份只适用于云盘副本集、云盘分片实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:ModifyBackupPolicy

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bp16cb162771****
PreferredBackupTime	string	否	执行备份的时间，格式为HH:mmZ-HH:mmZ（UTC 时间）。说明时间范围限制为 1 小时。	03:00Z-04:00Z
PreferredBackupPeriod	string	否	备份周期，取值说明： Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。重要为了数据安全，请一周至少备份两次 MongoDB 说明传入多个值，请用英文逗号（,）隔开。	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	integer	否	全量备份保留天数。说明 2021 年 09 月 10 日前用户默认保留天数为 7 天。 2021 年 09 月 10 日后新用户默认保留天数为 30 天。	30
EnableBackupLog	integer	否	是否打开日志备份，取值说明： 0：关闭（默认值）。 1：打开。重要分片集群不支持关闭日志备份	0
LogBackupRetentionPeriod	integer	否	日志备份保留天数，默认为 7 天。取值范围：7~730。	7
SnapshotBackupType	string	否	快照备份类型，取值说明： Flash：秒级备份。 Standard：常规备份（默认值）。	Standard
BackupInterval	string	否	高频备份频率，取值说明： -1：不开启高频备份。 30：每 30 分钟。 60：每 1 小时。 120：每 2 小时。 180：每 3 小时。 240：每 4 小时。 360：每 6 小时。 480：每 8 小时。 720：每 12 小时。说明当 SnapshotBackupType 取值为 Standard 时，该参数取值固定为-1。当 SnapshotBackupType 取值为 Flash，且该参数取值大于 0 时，高频备份才生效。	-1
HighFrequencyBackupRetention	integer	否	高频备份保留天数，使用该参数前需要先确认已经传入 BackupInterval 字段。默认保留时长一天。	1
BackupRetentionPolicyOnClusterDeletion	integer	否	备份保留策略。 0：实例释放时立即删除该实例的所有备份集 1：实例释放时会自动备份，长期保留该备份集 2：实例释放时会自动备份，并长期保留该集群的所有备份集详细信息请参见：长期保留备份	2
CrossBackupType	string	否	异地备份操作策略： update: 修改异地备份策略 delete: 删除异地备份策略说明异地备份必填	update
SrcRegion	string	否	实例所在地域。说明已删除实例恢复必填异地备份必填	cn-beijing
DestRegion	string	否	备份所在地域。说明异地备份必填	cn-hangzhou
CrossRetentionType	string	否	异地备份保留类型。 delay（保留一段时间） never（不过期）说明异地备份必填	delay
CrossRetentionValue	integer	否	异地备份保留时长，可设置 3-1825 天。说明异地备份必填当 CrossRetentionType 为 delay 时使用且必须使用。	7
CrossBackupPeriod	string	否	异地备份的保留时间。 Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日说明异地备份必填传入多个值，请用英文逗号（,）隔开。当备份设置为常规备份时，该值需要为 PreferredBackupPeriod 备份周期的子集。	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
EnableCrossLogBackup	integer	否	是否开启跨地域日志备份。说明异地备份必填 1：打开 (分片集群必须为 1，副本集如果想支持异地时间点恢复必须为 1) 0：关闭	1
CrossLogRetentionType	string	否	异地日志备份保留类型。 delay（保留一段时间） never（不过期）说明异地备份必填	delay
CrossLogRetentionValue	integer	否	异地日志备份保留时长，可设置 3-1825 天，需要小于等于 CrossRetentionValue 的值。说明异地备份必填	3
InstanceType	string	否	实例类型，取值： replicate sharding 说明当备份恢复类型为已删除实例重建时，需要且必填当备份恢复类型为异地备份克隆时，需要且必填	replicate
PreserveOneEachHour	boolean	否	是否开启按小时稀疏备份。 true：当备份频率为分钟级时，距离当前时间 1 小时内的快照全部保留。距离当前时间超过 1 小时且在 24 小时内的快照，仅保留整点后的第一个快照。 false：高频备份保留天数内的快照全部保留。	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	644A359C-B871-4DD3-97B5-ED91EF5809C2

示例

正常返回示例

JSON格式

{
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。