文档

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.-
    400IncorrectBackupPolicyThe current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console.当前实例开启了高级备份策略,目前不支持使用OpenAPI修改备份策略,需要在控制台进行修改。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
    400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
    400Api.NotSupportSpecified api is not supported.当前接口不支持。
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
    400KmsApiErrorUser secret key invalid.用户密钥失效。
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
    400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复,请重新设置连接字符串。
    400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
    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.操作不允许
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
    403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
    403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
    500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

    变更历史

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