调用ModifyBackupPolicy接口修改RDS实例备份设置。

调用该接口时,实例必须满足以下条件,否则将操作失败:

  • 实例不能为只读实例。
  • 实例状态为运行中。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyBackupPolicy

系统规定参数,取值:ModifyBackupPolicy

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。可通过接口DescribeDBInstances获取。

BackupPolicyMode String DataBackupPolicy

备份类型:

  • DataBackupPolicy:数据备份
  • LogBackupPolicy:日志备份
PreferredBackupTime String 00:00Z-01:00Z

执行备份任务的时间。格式:HH:mmZ-HH:mmZ(UTC时间)。

说明
  • BackupPolicyModeDataBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
PreferredBackupPeriod String Monday

备份周期。至少需要指定2天,多个取值用英文逗号(,)隔开。取值:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
说明
  • BackupInterval参数共同决定备份策略。例如:本参数指定周六周日备份,BackupInterval参数指定30分钟,则在每周的周六和周日每隔30分钟执行一次备份。
  • BackupPolicyMode参数为DataBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
BackupRetentionPeriod String 7

数据备份保留天数,取值:7~730

说明
  • BackupPolicyModeDataBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
BackupLog String Enable

是否开启日志备份。取值:

  • Enable:开启。
  • Disabled:关闭。
说明
  • BackupPolicyModeDataBackupPolicy时,用于开启或关闭日志备份。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
LogBackupRetentionPeriod String 7

日志备份保留天数。取值:7~730,且不大于数据备份保留天数。

说明
  • 当开启日志备份时,可设置日志备份文件的保留天数,目前仅支持MySQL、PostgreSQL、PPAS实例设置该值。
  • BackupPolicyMode参数为DataBackupPolicyLogBackupPolicy时都适用。
EnableBackupLog String 1

是否开启日志备份。取值:

  • True1:开启。
  • False0:关闭。
说明
  • BackupPolicyModeLogBackupPolicy时,用于开启或关闭日志备份。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
LocalLogRetentionHours String 18

日志备份本地保留小时数。取值:0~7*24,0表示不保留。

说明
  • BackupPolicyModeLogBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
LocalLogRetentionSpace String 30

本地日志最大循环空间使用率,超出后,则从最早的Binlog开始清理,直到空间使用率低于该比例。取值:0~50。默认不修改。

说明
  • BackupPolicyModeLogBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
HighSpaceUsageProtection String Enable

实例使用空间大于80%,或者剩余空间小于5GB时,是否无条件清理Binlog。取值:Enable | Disable。默认不修改。

说明
  • BackupPolicyModeLogBackupPolicy时,该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
LogBackupFrequency String LogInterval

日志备份频率,取值:

  • LogInterval:每30分钟备份一次。
  • 默认与数据备份频率一致。
说明
  • LogInterval参数仅适用于SQL Server。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
CompressType String 4

备份压缩方式。取值:

  • 1:zlib压缩,格式为tar.gz。
  • 4:quicklz压缩,格式为xb.gz。仅适用于MySQL 5.6/5.7,此备份压缩方式可用于单库单表恢复
  • 8:quicklz压缩,格式为xb.gz。仅适用于MySQL 8.0。暂不支持单库单表恢复。
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
ArchiveBackupRetentionPeriod String 365

归档备份的保留天数。默认为0,表示未开启归档备份。取值:30~1095

说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
ArchiveBackupKeepPolicy String ByMonth

归档备份的保留周期,该周期内能保存的备份个数由ArchiveBackupKeepCount决定。默认为0。取值:

  • ByMonth:月
  • ByWeek:周
  • KeepAll:全部保留
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
ArchiveBackupKeepCount Integer 1

归档备份的保留个数。默认为1。取值:

  • ArchiveBackupKeepPolicyByMonth时,取值为1~31
  • ArchiveBackupKeepPolicyByWeek时,取值为1~7
说明
  • ArchiveBackupKeepPolicyKeepAll时,本参数无需传入。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
ReleasedKeepPolicy String None

已删除实例的归档备份保留策略。默认为None。取值:

  • None:不保留
  • Lastest:保留最后一个
  • All:全部保留
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
LogBackupLocalRetentionNumber Integer 60

本地Binlog保留个数。默认为60。取值:6~100

说明
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
  • 如果实例类型为MySQL,可以传入-1,即不限制本地Binlog的保留个数。
Category String Standard

是否开启秒级备份。取值:

  • Flash:开启
  • Standard:关闭
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
BackupInterval String 30

快照备份频率。取值:

  • -1:不设置备份频率。
  • 30:30分钟。
  • 60:60分钟。
  • 120:120分钟。
  • 240:240分钟。
  • 480:480分钟。
说明
  • PreferredBackupPeriod参数共同决定备份策略。例如:PreferredBackupPeriod参数指定周六周日备份,本参数指定-1,则在每周的周六和周日各执行一次备份。
  • PostgreSQL实例必须是云盘实例。
  • SQL Server实例必须已开启快照备份
  • Category参数为Flash时本参数无效。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
BackupMethod String Physical

实例的备份方式。取值:

  • Physical:物理备份
  • Snapshot:快照备份

默认值:Physical

说明
  • 本参数仅对SQL Server云盘版实例生效。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。

返回数据

名称 类型 示例值 描述
CompressType String 4

备份压缩方式,取值:

  • 0:不压缩。
  • 1:zlib压缩。
  • 2:并行zlib压缩。
  • 4:quicklz压缩,开启了库表恢复。
  • 8:MySQL8.0 quicklz压缩但是还未支持库表恢复。
DBInstanceID String rm-uf6wjk5xxxxxxx

实例ID。

EnableBackupLog String 1

是否开启了日志备份。取值:

  • 1:开启
  • 0:关闭
HighSpaceUsageProtection String Disable

实例使用空间大于80%,或者剩余空间小于5GB时,是否无条件清理Binlog。

LocalLogRetentionHours Integer 18

日志备份本地保留小时数。

LocalLogRetentionSpace String 30

本地日志最大循环空间使用率。

LogBackupLocalRetentionNumber Integer 60

本地Binlog保留个数。

RequestId String DA147739-AEAD-4417-9089-65E9B1D8240D

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

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格式

{
    "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 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. 操作不允许

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