调用ModifyBackupPolicy接口修改RDS实例备份设置。
调用该接口时,实例必须满足以下条件,否则将操作失败:
- 实例不能为只读实例。
- 实例状态为运行中。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyBackupPolicy |
系统规定参数。取值:ModifyBackupPolicy。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx |
实例ID。可通过接口DescribeDBInstances获取。 |
BackupPolicyMode | String | 否 | DataBackupPolicy |
备份类型:
|
PreferredBackupTime | String | 否 | 00:00Z-01:00Z |
执行备份任务的时间。格式:HH:mmZ-HH:mmZ(UTC时间)。 说明
|
PreferredBackupPeriod | String | 否 | Monday |
备份周期。至少需要指定2天,多个取值用英文逗号(,)隔开。取值:
说明
|
BackupRetentionPeriod | String | 否 | 7 |
数据备份保留天数,取值:7~730。 说明
|
BackupLog | String | 否 | Enable |
是否开启日志备份。取值:
说明
|
LogBackupRetentionPeriod | String | 否 | 7 |
日志备份保留天数。取值:7~730,且不大于数据备份保留天数。 说明
|
EnableBackupLog | String | 否 | 1 |
是否开启日志备份。取值:
说明
|
LocalLogRetentionHours | String | 否 | 18 |
日志备份本地保留小时数。取值:0~7*24,0表示不保留。 说明
|
LocalLogRetentionSpace | String | 否 | 30 |
本地日志最大循环空间使用率,超出后,则从最早的Binlog开始清理,直到空间使用率低于该比例。取值:0~50。默认不修改。 说明
|
HighSpaceUsageProtection | String | 否 | Enable |
实例使用空间大于80%,或者剩余空间小于5GB时,是否无条件清理Binlog。取值:Enable | Disable。默认不修改。 说明
|
LogBackupFrequency | String | 否 | LogInterval |
日志备份频率,取值:
说明
|
CompressType | String | 否 | 4 |
备份压缩方式。取值:
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
|
ArchiveBackupRetentionPeriod | String | 否 | 365 |
归档备份的保留天数。默认为0,表示未开启归档备份。取值:30~1095。 说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
|
ArchiveBackupKeepPolicy | String | 否 | ByMonth |
归档备份的保留周期,该周期内能保存的备份个数由ArchiveBackupKeepCount决定。默认为0。取值:
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
|
ArchiveBackupKeepCount | Integer | 否 | 1 |
归档备份的保留个数。默认为1。取值:
说明
|
ReleasedKeepPolicy | String | 否 | None |
已删除实例的归档备份保留策略。默认为None。取值:
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
|
LogBackupLocalRetentionNumber | Integer | 否 | 60 |
本地Binlog保留个数。默认为60。取值:6~100。 说明
|
Category | String | 否 | Standard |
是否开启秒级备份。取值:
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
|
BackupInterval | String | 否 | 30 |
快照备份频率。取值:
说明
|
BackupMethod | String | 否 | Physical |
实例的备份方式。取值:
默认值:Physical 说明
|
EnableIncrementDataBackup | Boolean | 否 | false |
是否开启增量备份。取值:
说明
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | DA147739-AEAD-4417-9089-65E9B1D8240D |
请求ID。 |
CompressType | String | 4 |
备份压缩方式,取值:
|
LocalLogRetentionSpace | String | 30 |
本地日志最大循环空间使用率。 |
LogBackupLocalRetentionNumber | Integer | 60 |
本地Binlog保留个数。 |
DBInstanceID | String | rm-uf6wjk5xxxxxxx |
实例ID。 |
EnableBackupLog | String | 1 |
是否开启了日志备份。取值:
|
LocalLogRetentionHours | Integer | 18 |
日志备份本地保留小时数。 |
HighSpaceUsageProtection | String | Disable |
实例使用空间大于80%,或者剩余空间小于5GB时,是否无条件清理Binlog。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyBackupPolicyResponse>
<HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<EnableBackupLog>1</EnableBackupLog>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HighSpaceUsageProtection" : "Disable",
"DBInstanceID" : "rm-bp1z3xxxxx",
"RequestId" : "E4BF5598-ED12-4406-AAA4-F375428BE741",
"LocalLogRetentionHours" : "18",
"EnableBackupLog" : "1",
"LocalLogRetentionSpace" : "30",
"LogBackupLocalRetentionNumber" : 60
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidLogBackupFrequency.Malformed | Invalid log backup frequency. | 日志备份频率(LogBackupFrequency)无效,请检查参数是否正确。 |
400 | InvalidBackupRetentionPeriod.Malformed | The specified backup retention period is invalid. | 备份周期不能为空。请设置备份周期,备份周期不能小于1天或大于30天。 |
400 | BackupPropertyNotFound | Backup policy not found | 操作失败,无法找到备份策略。 |
400 | OperationDenied.SwitchToSnapshot | Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. | 操作失败,快照备份目前不支持跨区域存储。在切换到快照备份模式之前,请关闭跨区域备份。 |
403 | IncorrectCategory | Current Instance type does not support Category. | 当前实例类型不支持类别。 |
403 | OperationDenied.SwitchSnapshotToPhysical | Only physical backup to snapshot backup is supported. | 当前操作仅支持物理备份到快照备份。 |
403 | OperationDenied.ModifyBackupSwitchOff | The switch is not turned on. It is forbidden to modify the backup mode. | 切换失败,未开启跨地域备份。 |
403 | OperationDenied.ApiForbiddenForLogBackupFrequency | When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup. | 当实例为快照备份时,日志备份频率不允许为"与数据备份一致"。 |
403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | 当存储空间大于4000GB,仅支持快照备份。 |
403 | OperationDenied.ApiForbidden | Operation is not permitted. | 操作不允许 |
访问错误中心查看更多错误码。