调用ModifyBackupPolicy接口修改PolarDB集群的自动备份策略。

说明 您也可以通过控制台修改PolarDB集群的自动备份策略。具体信息,请参见备份设置

调试

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

请求参数

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

系统规定参数。取值:ModifyBackupPolicy

DBClusterId String pc-bp13wz9586voc****

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息,包括集群ID。
PreferredBackupTime String 15:00Z-16:00Z

执行自动备份的时间段,格式为hh:mmZ-hh:mmZ(UTC时间),且输入的数值必须为间隔1个小时的整点,如14:00Z-15:00Z

PreferredBackupPeriod String Monday,Tuesday

备份周期,取值范围如下:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
说明
  • 至少需要选择2天,多个值之间用英文逗号(,)隔开。
  • 如果您的PolarDB MySQL引擎所在的地域支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel1BackupRetentionPeriod String 3

一级备份保留周期,取值范围为3~14,单位为天。

DataLevel2BackupRetentionPeriod String 0

二级备份保留周期,取值范围如下:

  • 0:关闭二级备份功能。
  • 30~7300:二级备份保留周期,单位为天。
  • 1:二级备份永久保留。
    说明 创建集群时,默认取值为0,即关闭二级备份功能。
BackupRetentionPolicyOnClusterDeletion String NONE

删除集群时是否保留备份:

  • ALL:永久保留全部备份。
  • LATEST:永久保留最后一个备份。
  • NONE:不保留备份集。
说明 默认取值为NONE。
BackupFrequency String Normal

备份频率,取值如下:

  • Normal(默认):常规备份,每天定时备份一次。
  • 2/24H:高频备份,每2小时备份一次。
  • 3/24H:高频备份,每3小时备份一次。
  • 4/24H:高频备份,每4小时备份一次。
说明
  • 开启高频备份后,备份完成时间在24小时内的备份会全部保留。超过24小时的,系统将仅保留每日00:00点后完成的第一个备份,其他均被删除。
  • 开启高频备份后,备份周期PreferredBackupPeriod参数会默认选择一周内的所有天数(即从周一至周日)。
  • 如果您的PolarDB MySQL引擎所在的地域支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel1BackupFrequency String Normal

备份频率,取值如下:

  • Normal(默认):常规备份,每天定时备份一次。
  • 2/24H:高频备份,每2小时备份一次。
  • 3/24H:高频备份,每3小时备份一次。
  • 4/24H:高频备份,每4小时备份一次。
说明
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel1BackupTime String 15:00Z-16:00Z

执行自动备份的时间段,格式为hh:mmZ-hh:mmZ(UTC时间),且输入的数值必须为间隔1个小时的整点,如14:00Z-15:00Z

说明
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel1BackupPeriod String Monday,Tuesday

一级备份周期,取值范围如下:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
说明
  • 至少需要选择2天,多个值之间用英文逗号(,)隔开。
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel2BackupPeriod String Monday,Tuesday

二级备份周期,取值范围如下:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
说明
  • 至少需要选择2天,多个值之间用英文逗号(,)隔开。
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能,将不支持该参数。跨地域备份支持的地域请参见概述
DataLevel2BackupAnotherRegionRegion String cn-hangzhou

二级备份跨地域备份区域。跨地域备份支持的地域请参见概述

DataLevel2BackupAnotherRegionRetentionPeriod String 30

二级备份跨地域备份保留周期。取值范围如下:

  • 0:关闭二级备份功能。
  • 30~7300:二级备份保留周期,单位为天。
  • 1:二级备份永久保留。
    说明 创建集群时,默认取值为0,即关闭二级备份跨地域备份功能。

返回数据

名称 类型 示例值 描述
RequestId String C5A5DF0E-5968-4DC1-882E-AC2FE7******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyBackupPolicy
&DBClusterId=pc-bp13wz9586voc****
&PreferredBackupTime=15:00Z-16:00Z
&PreferredBackupPeriod=Monday,Tuesday
&DataLevel1BackupRetentionPeriod=3
&DataLevel2BackupRetentionPeriod=0
&BackupRetentionPolicyOnClusterDeletion=NONE
&BackupFrequency=Normal
&DataLevel1BackupFrequency=Normal
&DataLevel1BackupTime=15:00Z-16:00Z
&DataLevel1BackupPeriod=Monday,Tuesday
&DataLevel2BackupPeriod=Monday,Tuesday
&DataLevel2BackupAnotherRegionRegion=cn-hangzhou
&DataLevel2BackupAnotherRegionRetentionPeriod=30
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyBackupPolicyResponse>
<RequestId>C5A5DF0E-5968-4DC1-882E-AC2FE7******</RequestId>
</ModifyBackupPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C5A5DF0E-5968-4DC1-882E-AC2FE7******"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDataLevel1BackupRetentionPeriod.Malformed The specified parameter DataLevel1BackupRetentionPeriod is not valid. 操作失败,一级备份保留周期(DataLevel1BackupRetentionPeriod )参数无效。
400 InvalidDataLevel2BackupRetentionPeriod.Malformed The specified parameter DataLevel2BackupRetentionPeriod is not valid. 操作失败,二级备份保留周期(DataLevel2BackupRetentionPeriod )参数无效。
400 InvalidBackupRetentionPeriod.Malformed The specified parameter BackupRetentionPeriod is not valid. 操作失败,备份保留周期(BackupRetentionPeriod)参数无效。
400 InvalidBackupFrequency.Malformed The specified parameter BackupFrequency is not valid. 操作失败,备份频率(BackupFrequency )参数无效。
400 InvalidPreferredBackupPeriod.Malformed The specified parameter PreferredBackupPeriod is not valid. 操作失败,数据备份周期(PreferredBackupPeriod)无效。
400 InvalidDataLevel2BackupPeriod.Malformed The specified parameter DataLevel2BackupPeriod is not valid. 指定的参数DataLevel2BackupPeriod无效
403 IncorrectBackupPolicy Current DB type does not support low frequency backupPolicy operation. 当前DB类型不支持低频备份操作
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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