调用ModifyBackupPolicy接口修改RDS实例备份设置。
接口说明
调用该接口时,实例必须满足以下条件,否则将操作失败:
- 实例不能为只读实例。
- 实例状态为运行中。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyBackupPolicy | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例ID。可通过接口DescribeDBInstances获取。 | rm-uf6wjk5xxxxxxx |
BackupPolicyMode | string | 否 | 备份类型:
| DataBackupPolicy |
PreferredBackupTime | string | 否 | 执行备份任务的时间。格式:HH:mmZ-HH:mmZ(UTC时间)。 说明 | 00:00Z-01:00Z |
PreferredBackupPeriod | string | 否 | 备份周期。至少需要指定2天,多个取值用英文逗号(,)隔开。取值:
说明 | Monday |
BackupRetentionPeriod | string | 否 | 数据备份保留天数,取值:7~730。 说明 | 7 |
BackupLog | string | 否 | 是否开启日志备份。取值:
说明 | Enable |
LogBackupRetentionPeriod | string | 否 | 日志备份保留天数。取值:7~730,且不大于数据备份保留天数。 说明 | 7 |
EnableBackupLog | string | 否 | 是否开启日志备份。取值:
说明 | 1 |
LocalLogRetentionHours | string | 否 | 日志备份本地保留小时数。取值:0~7*24,0表示不保留。 说明 | 18 |
LocalLogRetentionSpace | string | 否 | 本地日志最大循环空间使用率,超出后,则从最早的Binlog开始清理,直到空间使用率低于该比例。取值:0~50。默认不修改。 说明 | 30 |
HighSpaceUsageProtection | string | 否 | 实例使用空间大于80%,或者剩余空间小于5GB时,是否无条件清理Binlog。取值:Enable | Disable。默认不修改。 说明 | Enable |
LogBackupFrequency | string | 否 | 日志备份频率,取值:
说明 | LogInterval |
CompressType | string | 否 | 备份压缩方式。取值:
说明仅在BackupPolicyMode参数为DataBackupPolicy时生效。 | 4 |
ArchiveBackupRetentionPeriod | string | 否 | 归档备份的保留天数。默认为0,表示未开启归档备份。取值:30~1095。 说明仅在BackupPolicyMode参数为DataBackupPolicy时生效。 | 365 |
ArchiveBackupKeepPolicy | string | 否 | 归档备份的保留周期,该周期内能保存的备份个数由ArchiveBackupKeepCount决定。默认为0。取值:
说明仅在BackupPolicyMode参数为DataBackupPolicy时生效。 | ByMonth |
ArchiveBackupKeepCount | integer | 否 | 归档备份的保留个数。默认为1。取值:
说明 | 1 |
ReleasedKeepPolicy | string | 否 | 已删除实例的归档备份保留策略。默认为None。取值:
说明仅在BackupPolicyMode参数为DataBackupPolicy时生效。 | None |
LogBackupLocalRetentionNumber | integer | 否 | 本地Binlog保留个数。默认为60。取值:6~100。 说明 | 60 |
Category | string | 否 | 是否开启秒级备份。取值:
说明仅在BackupPolicyMode参数为DataBackupPolicy时生效。 | Standard |
BackupInterval | string | 否 | 快照备份频率。取值:
说明 | 30 |
BackupMethod | string | 否 | 实例的备份方式。取值:
默认值:Physical 说明 | Physical |
EnableIncrementDataBackup | boolean | 否 | 是否开启增量备份。取值:
说明 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
"CompressType": "4",
"LocalLogRetentionSpace": "30",
"LogBackupLocalRetentionNumber": 60,
"DBInstanceID": "rm-uf6wjk5xxxxxxx",
"EnableBackupLog": "1",
"LocalLogRetentionHours": 18,
"HighSpaceUsageProtection": "Disable"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidColdRetention.Format | Invalid cold retention format. | - |
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. | 操作失败,快照备份目前不支持跨区域存储。在切换到快照备份模式之前,请关闭跨区域备份。 |
400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | - |
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. | 操作不允许 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2022-05-10 | OpenAPI 错误码发生变更 | |||||||
|