AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云原生数据库 PolarDB 开发参考 PolarDB MySQL版/PostgreSQL版API参考 API参考指南 API目录 备份管理 备份策略 ModifyBackupPolicy - 修改备份策略设置

ModifyBackupPolicy - 修改备份策略设置

更新时间：
产品详情
我的收藏

修改PolarDB集群的自动备份策略。

接口说明

说明

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:ModifyBackupPolicy

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBClusterId

string

是

集群 ID。

说明

您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。

pc-bp13wz9586voc****
PreferredBackupTime

string

否

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

15:00Z-16:00Z
PreferredBackupPeriod

string

否

备份周期，取值范围如下：

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

说明

    • 至少需要选择 2 天，多个值之间用英文逗号（,）隔开。

    • 如果您的 PolarDB MySQL 版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

Monday,Tuesday
DataLevel1BackupRetentionPeriod

string

否

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

说明

  • 开启高级备份后，该字段不再生效，请使用参数 AdvancedDataPolicies。

3
DataLevel2BackupRetentionPeriod

string

否

二级备份保留周期，取值范围如下：

  • 0：关闭二级备份功能。

  • 30～7300：二级备份保留周期，单位为天。

  • -1：二级备份长期保留。

说明

    • 创建集群时，默认取值为 0，即关闭二级备份功能。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

0
BackupRetentionPolicyOnClusterDeletion

string

否

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

  • ALL：长期保留全部备份。

  • LATEST：长期保留最后一个备份。

  • NONE：不保留备份集。

说明

默认取值为 NONE。

NONE
BackupFrequency

string

否

备份频率，取值如下：

  • Normal（默认）：常规备份，每天定时备份一次。

  • 2/24H：高频备份，每 2 小时备份一次。

  • 3/24H：高频备份，每 3 小时备份一次。

  • 4/24H：高频备份，每 4 小时备份一次。

说明

    • 开启高频备份后，备份完成时间在 24 小时内的备份会全部保留。超过 24 小时的，系统将仅保留每日 00:00 点后完成的第一个备份，其他均被删除。

    • 开启高频备份后，备份周期 PreferredBackupPeriod 参数会默认选择一周内的所有天数（即从周一至周日）。

    • 如果您的 PolarDB MySQL 版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

Normal
DataLevel1BackupFrequency

string

否

备份频率，取值如下：

  • Normal（默认）：常规备份，每天定时备份一次。

  • 2/24H：高频备份，每 2 小时备份一次。

  • 3/24H：高频备份，每 3 小时备份一次。

  • 4/24H：高频备份，每 4 小时备份一次。

说明

    • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

    • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

Normal
DataLevel1BackupTime

string

否

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

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

15:00Z-16:00Z
DataLevel1BackupPeriod

string

否

一级备份周期，取值范围如下：

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

说明

    • 至少需要选择 2 天，多个值之间用英文逗号（,）隔开。

    • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

    • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

Monday,Tuesday
DataLevel2BackupPeriod

string

否

二级备份周期，取值范围如下：

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

说明

    • 至少需要选择 2 天，多个值之间用英文逗号（,）隔开。

    • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

    • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

Monday,Tuesday
DataLevel2BackupAnotherRegionRegion

string

否

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

说明

  • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

cn-hangzhou
DataLevel2BackupAnotherRegionRetentionPeriod

string

否

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

  • 0：关闭二级备份功能。

  • 30～7300：二级备份保留周期，单位为天。

  • -1：二级备份长期保留。

说明

    • 创建集群时，默认取值为 0，即关闭二级备份跨地域备份功能。

    • 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。

30
BackupPolicyLevel

string

否

目标备份策略等级。取值范围如下：

  • Normal：常规备份

  • Advanced：高级备份

说明

    • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

    • 您可通过 DescribeBackupPolicy 接口的返回值 AdvancedPolicyOption 确认集群是否支持开启高级备份。若集群支持开启高级备份，可通过 高级备份设置 申请使用该功能。

    • 高级备份开启后不支持回退至常规备份。

Normal
AdvancedDataPolicies

array<object>

否

高级备份策略。

说明

    • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

    • 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。

object

否

ActionType

string

否

操作类型，取值如下：

  • CREATE：新增

  • UPDATE：修改

  • DELETE：删除

CREATE
OnlyPreserveOneEachHour

boolean

否

每小时备份保留策略。取值如下：

  • true：超过 1 小时只保留每小时内最早的备份集。

  • false：保留全部备份集。

说明

该参数不支持修改，固定为 true。

true
RetentionValue

string

否

备份保留天数。

7
BakType

string

否

备份类型，取值如下：

  • F：全量备份

说明

该参数不支持修改，固定为 F。

F
FilterKey

string

否

调度类型，取值如下：

  • dayOfWeek：按周调度

  • dayOfMonth：按月调度

  • dayOfYear：按年调度

  • backupInterval：固定间隔调度

说明

仅当 FilterType 为 crontab 时，需要该参数。

dayOfWeek
FilterValue

string

否

备份周期。

1,2,3,4,5,6,7
DestType

string

否

备份策略目标类型，取值如下：

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level2
FilterType

string

否

高级策略筛选类型，取值如下：

  • crontab：周期调度

  • event：事件调度

crontab
SrcRegion

string

否

备份策略源地域。

cn-shanghai
AutoCreated

boolean

否

是否为系统自动生成的备份策略。

说明

该参数值将自动生成，无需传递。

false
SrcType

string

否

备份策略源类型，取值如下：

  • db：数据库集群

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
OnlyPreserveOneEachDay

boolean

否

24 小时备份保留策略。

  • true：超过 24 小时仅保留当天第 1 个备份集

  • false：全保留

true
DumpAction

string

否

一级备份转二级备份方式，取值如下：

  • copy：复制

copy
PolicyId

string

否

备份策略 ID，可调用 DescribeBackupPolicy 查看。

71930ac2e9f15e41615e10627c******

DestRegion

string

否

备份策略目标地域。

cn-beijing
RetentionType

string

否

备份集保留周期类型，取值如下：

  • never：永不过期

  • delay：固定天数过期

delay

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

C5A5DF0E-5968-4DC1-882E-AC2FE7******

示例

正常返回示例

JSON格式

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

异常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述
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无效
400 InvalidDataLevel1BackupPeriod.Malformed The specified parameter DataLevel1BackupPeriod is not valid. 指定的参数DataLevel1BackupPeriod无效。
400 InvalidPreferredBackupTime.Malformed The specified parameter PreferredBackupTime is not valid. 操作失败，执行自动备份的时间段（ PreferredBackupTime）无效。
400 InvalidDataLevel1BackupTime.Malformed The specified parameter DataLevel1BackupTime is not valid. 指定的参数DataLevel1BackupTime无效。
400 InvalidDataLevel1BackupFrequency.Malformed The specified parameter DataLevel1BackupFrequency is not valid. 指定的参数DataLevel1BackupFrequency无效。
400 InvalidDataLevel2AnotherRegionRegion.NotFound The specified parameter DataLevel2BackupAnotherRegionRegion does not found. 找不到指定的参数DataLevel2BackupAnotherRegionRegion。
400 InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid. 指定的参数DataLevel2BackupAnotherRegionRetentionPeriod无效。
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。
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的 DBClusterId。
404 InvalidParam new archiveBackup policy already exists. dumpretention parameter cannot used alone 新的archiveBackup策略已存在。dumpretention参数不能单独使用
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeLogBackupPolicy - 查询集群日志备份保留策略下一篇：ModifyLogBackupPolicy - 修改集群日志备份保留策略