文档

ModifyBackupPolicy - 修改实例备份策略

更新时间:
一键部署

该接口用于修改RDS实例的备份策略设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyBackupPolicyWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:EnableBackupLog
  • rds:BackupLog

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
BackupPolicyModestring

备份类型:

  • DataBackupPolicy:数据备份
  • LogBackupPolicy:日志备份
DataBackupPolicy
PreferredBackupTimestring

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

说明
  • BackupPolicyModeDataBackupPolicy 时,该参数必传。
  • 仅在 BackupPolicyMode 参数为 DataBackupPolicy 时生效。
  • 00:00Z-01:00Z
    PreferredBackupPeriodstring

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

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

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

    说明
  • BackupPolicyModeDataBackupPolicy 时,该参数必传。
  • 仅在 BackupPolicyMode 参数为 DataBackupPolicy 时生效。
  • 7
    BackupLogstring

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

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

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

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

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

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

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

    说明
  • BackupPolicyModeLogBackupPolicy 时,该参数必传。
  • 仅在 BackupPolicyMode 参数为 LogBackupPolicy 时生效。
  • 18
    LocalLogRetentionSpacestring

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

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

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

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

    日志备份频率,取值:

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

    备份压缩方式。取值:

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

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

    说明 仅在 BackupPolicyMode 参数为 DataBackupPolicy 时生效。
    365
    ArchiveBackupKeepPolicystring

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

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

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

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

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

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

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

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

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

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

    快照备份频率。取值:

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

    实例的备份方式。取值:

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

    默认值:Physical

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

    是否开启增量备份。取值:

    • False(默认):关闭
    • True:开启
    说明
  • 本参数仅对 SQL Server 云盘版实例生效。
  • 仅在 BackupPolicyMode 参数为 DataBackupPolicy 时生效。
  • False
    BackupPriorityinteger

    设置备库备份选项。取值:

    • 1:优先备库
    • 2:强制主库
    说明
  • 该参数仅适用于 SQL Server 集群版实例。
  • 仅当 BackupMethod 取值为 Physical 时,该参数才生效。如果 BackupMethod 设置为 Snapshot,SQL Server 集群版实例将强制在主库备份。
  • 2

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    DA147739-AEAD-4417-9089-65E9B1D8240D
    CompressTypestring

    备份压缩方式,取值:

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

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

    30
    LogBackupLocalRetentionNumberinteger

    本地 Binlog 保留个数。

    60
    DBInstanceIDstring

    实例 ID。

    rm-uf6wjk5****
    EnableBackupLogstring

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

    • 1:开启
    • 0:关闭
    1
    LocalLogRetentionHoursinteger

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

    18
    HighSpaceUsageProtectionstring

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

    Disable

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
      "CompressType": "4",
      "LocalLogRetentionSpace": "30",
      "LogBackupLocalRetentionNumber": 60,
      "DBInstanceID": "rm-uf6wjk5****",
      "EnableBackupLog": "1",
      "LocalLogRetentionHours": 18,
      "HighSpaceUsageProtection": "Disable"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidColdRetention.FormatInvalid cold retention format.-
    400InvalidLogBackupFrequency.MalformedInvalid log backup frequency.日志备份频率(LogBackupFrequency)无效,请检查参数是否正确。
    400InvalidBackupRetentionPeriod.MalformedThe specified backup retention period is invalid.备份周期不能为空。请设置备份周期,备份周期不能小于1天或大于30天。
    400BackupPropertyNotFoundBackup policy not found操作失败,无法找到备份策略。
    400OperationDenied.SwitchToSnapshotSnapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.操作失败,快照备份目前不支持跨区域存储。在切换到快照备份模式之前,请关闭跨区域备份。
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.-
    403IncorrectCategoryCurrent Instance type does not support Category.当前实例类型不支持类别。
    403OperationDenied.SwitchSnapshotToPhysicalOnly physical backup to snapshot backup is supported.当前操作仅支持物理备份到快照备份。
    403OperationDenied.ModifyBackupSwitchOffThe switch is not turned on. It is forbidden to modify the backup mode.切换失败,未开启跨地域备份。
    403OperationDenied.ApiForbiddenForLogBackupFrequencyWhen the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.当实例为快照备份时,日志备份频率不允许为"与数据备份一致"。
    403OperationDenied.NotSupportedBackupMethodWhen the storage is larger than 4000 GB, only snapshot backup is supported.当存储空间大于4000GB,仅支持快照备份。
    403OperationDenied.ApiForbiddenOperation is not permitted.操作不允许

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

    变更历史

    变更时间变更内容概要操作
    2023-06-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    入参OpenAPI 入参发生变更
      新增入参:BackupPriority
    2022-05-10OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
    • 本页导读 (1)
    文档反馈