ModifyAdvancedBackupPolicy - 修改高级备份策略 - 云数据库 MongoDB

修改高级备份策略

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-2zeb2d64cb46xxxx
PreferredBackupTime	string	否	执行备份的时间，格式为HH:mmZ-HH:mmZ（UTC 时间）。说明时间范围限制为 1 小时。	09:00Z-10:00Z
SnapshotBackupType	string	否	快照备份类型，取值说明： Flash：秒级备份。 Standard：常规备份（默认值）。	Standard
BackupRetentionPolicyOnClusterDeletion	integer	是	备份保留策略。 0：实例释放时立即删除该实例的所有备份集 1：实例释放时会长期保留最后一个备份集 2：实例释放时会长期保留所有备份集	0
AdvancedBackupDataPolicies	array<object>	否	备份策略列表。
	object	否
PolicyId	string	否	备份策略 ID。重要当 ActionType!=CREATE 时必填。	xxxxxx
ActionType	string	是	处置动作。取值： CREATE：新增 UPDATE：修改 DELETE：删除，此时，其他参数只需要传入 PolicyId。	CREATE
RetentionType	string	否	备份集保留周期类型 never：长期保留 delay：固定天数保留重要 ActionType!=delete 时必填	delay
RetentionPeriod	integer	否	备份计划保留天数。同地域备份： 7-7300 天。跨异地备份： 3-1825 天。重要当 RetentionType 为 delay 时必填。	7
BackupPolicy	string	否	高级策略调度类型，取值如下： dayOfWeek：按周调度 dayOfMonth：按月调度 dayOfYear：按年调度 backupInterval：固定间隔调度（高频备份）说明不支持多条高频备份策略。不支持多条异地备份，且异地备份策略只支持 dayOfWeek 重要 ActionType!=delete 时必填	dayOfWeek
PreferredBackupPeriod	string	否	备份周期当 BackupPolicy=dayOfWeek : 1,2,3,4,5,6,7 表示周一到周五，一周至少备份 2 次。当 BackupPolicy=dayOfMonth：1,3,-1 表示每月 1、3 和最后一天。 -1 表示每月最后一天。当 BackupPolicy=dayOfYear ： 01-07 表示 1 月 7 日，只能选一天。当 BackupPolicy=backupInterval：取下列数字中的一个，单位 min。其中，分片集群选择范围为 30,60,120,180,240,360,480,720，副本集选择范围为 15,30,60,120,180,240, 360,480,720。注意：重要 ActionType!=delete 时必填，异地备份策略只支持 dayOfWeek。	1,4,6
SrcRegion	string	否	实例所在地域。重要 ActionType!=delete 时必填	cn-guangzhou
SrcType	string	否	备份策略源类型。 db：同地域备份 level1 ：跨地域备份重要 ActionType!=delete 时必填	db
DestRegion	string	否	备份策略目标地域。重要 ActionType!=delete 时必填	cn-guangzhou
DestType	string	否	备份策略目标类型。 level1 ：同地域备份 level2Cross：跨地域备份重要 ActionType!=delete 时必填	level1
PreserveOneEachHour	boolean	否	是否开启按小时稀疏备份。 true：当备份频率为分钟级时，距离当前时间 1 小时内的快照全部保留。距离当前时间超过 1 小时且在 24 小时内的快照，仅保留整点后的第一个快照。 false：高频备份保留天数内的快照全部保留。	False
AdvancedBackupLogPolicies	array<object>	否	日志备份策略列表。
	object	否
EnableLogBackup	integer	是	是否开启日志备份： 1：开启 0：未开启说明分片实例必须开启日志备份。打开异地日志备份必须先打开同地域日志备份。	1
RetentionType	string	否	日志备份保留周期类型： never：长期保留 delay：固定天数保留	delay
RetentionPeriod	integer	否	日志备份保留天数, 当 RetentionType 为 delay 时生效。同地域备份：7-7300 天跨异地备份：3-1825 天，且需要小于异地备份策略的备份保留时间。	7
SrcRegion	string	否	源实例所在区域。	cn-hangzhou
SrcType	string	否	日志备份策略源类型。 db：同地域备份 level1 ：跨地域备份	db
DestRegion	string	否	异地日志备份所在地域。说明异地备份必填	cn-huhehaote
DestType	string	否	日志备份策略目标类型。 level1 ：同地域备份 level2Cross：跨地域备份	level1
PolicyId	string	否	日志备份策略 id，只有异地日志备份策略存在且必填。	xxxx
ActionType	string	是	操作类型 CREATE：创建 UPDATE：修改重要只针对异地备份生效，删除异地备份时，使用 update enablelogbackup=0 的方式。	CREATE

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	2F42BB4E-461F-5B55-A37C-53B1141C****

示例

正常返回示例

JSON格式

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****"
}

错误码

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

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

变更历史

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