AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

ModifyBackupPolicy - 修改备份策略

更新时间：
复制为 MD 格式
产品详情
我的收藏

修改PolarDB实例备份策略。

接口说明

适用引擎

PolarDB MySQL 版

说明

当前该接口仅针对特定客户开放使用，如有需求，请到 DBS 客户咨询群（钉钉群号：35585947）申请使用。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:ModifyBackupPolicy

update

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionCode

string

否

备份集所在地域。

cn-shanghai
PreferredBackupWindowBegin

string

否

基础备份窗口开始时间。

17:00Z
InstanceName

string

否

PolarDB 实例 ID。

pc-2ze3nrr64c5****
Category

string

否

备份类型

  • Flash：秒级备份

  • Standard：普通备份

Flash
AdvanceLogPolicies

array<object>

否

备份策略目标地域。

object

否

备份策略源地域。

LogRetentionType

string

否

保留周期类型 Never - 永不过期 Delay - 固定天数过期

Never
DestType

string

否

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

level1
FilterType

string

否

高级策略筛选类型 Crontab - 周期调度 Event - 事件调度

crontab
ActionType

string

否

操作类型，CREATE，UPDATE，DELETE

CREATE
SrcRegion

string

否

备份策略源 region

cn-hangzhou
EnableLogBackup

integer

否

是否开启日志备份，返回值如下：

  • 1：开启

  • 0：未开启

1
SrcType

string

否

备份策略源类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

db
LogRetentionValue

string

否

过期天数

30
PolicyId

string

否

高级策略 ID

31289676-bb8d-4dee-b83e-******
FilterKey

string

否

调度类型，当前仅当 filterType 为 crontab 时有效 dayOfWeek - 按周调度 dayOfMonth - 按月调度 dayOfYear - 按年调度 backupInterval - 固定间隔调度

dayOfMonth
DestRegion

string

否

备份策略目标 region

cn-hangzhou
FilterValue

string

否

具体 Filter 的值

1
AdvanceDataPolicies

array<object>

否

数据备份策略详情。

object

否

策略详情。

DestType

string

否

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
FilterType

string

否

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

  • crontab：周期调度

  • event：事件调度

crontab
ActionType

string

否

操作类型，取值如下：

  • CREATE：新增

  • UPDATE：修改

  • DELETE：删除

UPDATE
SrcRegion

string

否

备份策略源地域。

cn-shanghai
SrcType

string

否

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

db
OnlyPreserveOneEachDay

boolean

否

一天之前的高频备份集，是否只保留每天一个

true
RetentionValue

string

否

过期天数。

4
PolicyId

string

否

高级策略 ID，可调用 DescribeBackupPolicy 查看。

6s67c7i3y8f8p72808p******
FilterKey

string

否

调度类型，取值如下：

  • dayOfWeek：按周调度

  • dayOfMonth：按月调度

  • dayOfYear：按年调度

  • backupInterval：固定间隔调度

说明

仅当 FilterType 为 crontab 时，返回该参数。

backupInterval
DestRegion

string

否

备份策略目标地域。

cn-shanghai
FilterValue

string

否

备份周期。

180
RetentionType

string

否

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

  • never：永不过期

  • delay：固定天数过期

delay
StorageClass

string

否

Bucket 的存储类型。 取值范围如下：

  • Standard（默认）：标准存储

  • IA：低频访问

  • Archive：归档存储

  • ColdArchive：冷归档存储

  • DeepColdArchive：深度冷归档存储

Standard
AdvanceIncPolicies

array<object>

否

备份策略目标 region

object

否

备份策略源 region

DestType

string

否

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

level1
FilterType

string

否

高级策略筛选类型 Crontab - 周期调度 Event - 事件调度

crontab
ActionType

string

否

操作类型，CREATE，UPDATE，DELETE

CREATE
SrcRegion

string

否

备份策略源 region

cn-hangzhou
SrcType

string

否

备份策略源类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

db
OnlyPreserveOneEachDay

boolean

否

一天之前的高频备份集，是否只保留每天一个

true
RetentionValue

string

否

过期天数

365
PolicyId

string

否

高级策略 ID

1
FilterKey

string

否

调度类型，当前仅当 filterType 为 crontab 时有效 dayOfWeek - 按周调度 dayOfMonth - 按月调度 dayOfYear - 按年调度 backupInterval - 固定间隔调度

dayOfMonth
DestRegion

string

否

备份策略目标 region

cn-hangzhou
FilterValue

string

否

具体 Filter 的值

1
RetentionType

string

否

保留周期类型 Never - 永不过期 Delay - 固定天数过期

delay
BackupRetentionPolicyOnClusterDeletion

string

否

已删除实例的归档备份保留策略，返回值如下：

  • NONE：不保留

  • LATEST：保留最后一个

  • ALL：全部保留

0
BackupMethod

string

否

备份方式，取值如下：

  • logical：逻辑备份

  • physical：物理备份

logical
BackupPriority

integer

否

备库备份的设置策略，返回值如下：

  • 1：优先备库

  • 2：强制主库

说明

该参数仅适用于 RDS SQL Server 实例，其他引擎返回值为 0。

2
EnableIncBackup

boolean

否

是否开启增量备份。

true

返回参数

名称

类型

描述

示例值

object

返回参数详情。

RequestId

string

请求 ID。

D570F209-A166-50C6-98A3-155A20B218B7
Message

string

返回信息。

instanceName can not be empty.
Data

object

备份策略详情。

PreferredBackupWindowBegin

string

基础备份窗口开始时间。

17:00Z
PreferredBackupWindow

string

基础备份窗口。

17:00Z-18:00Z
Category

string

是否开启秒级备份，返回值如下：

  • Flash：已开启秒级备份

  • Standard：普通备份

说明

该参数仅对 MySQL 生效。

Standard
AdvanceLogPolicies

array<object>

策略详情。

object

策略详情。

LogRetentionType

string

日志备份保留类型 Never - 永不过期 Delay - 按天过期

delay
DestType

string

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

level1
FilterType

string

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

  • crontab：周期调度

  • event：事件调度

crontab
SrcRegion

string

备份策略源 region

cn-beijing
EnableLogBackup

integer

预留参数，无需关注。

1
SrcType

string

备份策略源类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

level1
PolicyId

string

备份策略 ID

dc13b153acc91141789122c23835****
DestRegion

string

备份策略目标 region

cn-shanghai
LogRetentionValue

string

日志备份保留时间

3
FilterKey

string

调度类型，当前仅当 filterType 为 crontab 时有效 dayOfWeek - 按周调度 dayOfMonth - 按月调度 dayOfYear - 按年调度 backupInterval - 固定间隔调度

dayOfMonth
FilterValue

string

备份周期。

1
AdvanceDataPolicies

array<object>

数据备份策略详情。

object

策略详情。

RetentionValue

string

过期天数。

4
BakType

string

备份类型，返回值如下：

  • F：全量备份

  • L：日志备份

F
FilterKey

string

调度类型，返回值如下：

  • dayOfWeek：按周调度

  • dayOfMonth：按月调度

  • dayOfYear：按年调度

  • backupInterval：固定间隔调度

说明

仅当 FilterType 为 crontab 时，返回该参数。

backupInterval
FilterValue

string

备份周期。

180
DestType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
FilterType

string

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

  • crontab：周期调度

  • event：事件调度

crontab
SrcRegion

string

备份策略源地域。

cn-shanghai
AutoCreated

boolean

是否为系统自动生成的备份策略，返回值如下：

  • true：系统生成策略

  • false：用户自定义策略

false
SrcType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

db
OnlyPreserveOneEachDay

boolean

onlyPreserveOneEachDay

  • true：每天只保留一个

  • false：全保留

true
DumpAction

string

转储策略详情，返回值如下：

  • copy：复制

  • move：转储

copy
PolicyId

string

高级策略 ID。

dc13b153acc91141789122c23835****
DestRegion

string

备份策略目标地域。

cn-shanghai
RetentionType

string

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

  • never：永不过期

  • delay：固定天数过期

delay
StorageClass

string

数据存储类型。

ARCHIVE
AdvanceIncPolicies

array<object>

保留周期类型 Never - 永不过期 Delay - 固定天数过期

object

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

RetentionValue

string

过期天数

365
BakType

string

备份类型 F - 全量 L 日志

F
FilterKey

string

调度类型，当前仅当 filterType 为 crontab 时有效 dayOfWeek - 按周调度 dayOfMonth - 按月调度 dayOfYear - 按年调度 backupInterval - 固定间隔调度

dayOfMonth
FilterValue

string

具体 Filter 的值

1
DestType

string

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

level1
FilterType

string

高级策略筛选类型 Crontab - 周期调度 Event - 事件调度

Crontab
SrcRegion

string

备份策略源 region

cn-hangzhou
AutoCreated

boolean

是否系统自动生成

true
SrcType

string

备份策略源类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

db
OnlyPreserveOneEachDay

boolean

24 小时备份保留策略。

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

  • false：全保留

true
DumpAction

string

转储策略 Copy - 复制 Move - 转储

Copy
PolicyId

string

高级策略 ID

smp-8sv763r9boydzb***
DestRegion

string

备份策略目标 region

cn-hangzhou
RetentionType

string

保留周期类型 Never - 永不过期 Delay - 固定天数过期

Delay
BackupRetentionPolicyOnClusterDeletion

string

已删除实例的归档备份保留策略，返回值如下：

  • NONE：不保留

  • LATEST：保留最后一个

  • ALL：全部保留

LATEST
BackupMethod

string

备份方式，返回值如下：

  • Physical：物理备份

  • Snapshot：快照备份

Physical
BackupPriority

integer

备库备份的设置策略，返回值如下：

  • 1：优先备库

  • 2：强制主库

说明

该参数仅适用于 RDS SQL Server 实例，其他引擎返回值为 0。

1
EnableIncBackup

boolean

是否开启增量备份。

true
ErrMessage

string

错误信息。

The specified parameter %s value is not valid.
Code

string

状态码。

Success
Success

string

请求是否成功，返回值如下：

  • true：请求成功

  • false：请求失败

true
ErrCode

string

错误码。

Success

示例

正常返回示例

JSON格式

{
  "RequestId": "D570F209-A166-50C6-98A3-155A20B218B7",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupWindowBegin": "17:00Z",
    "PreferredBackupWindow": "17:00Z-18:00Z",
    "Category": "Standard",
    "AdvanceLogPolicies": [
      {
        "LogRetentionType": "delay",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "EnableLogBackup": 1,
        "SrcType": "level1",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "LogRetentionValue": "3",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "RetentionValue": "4",
        "BakType": "F",
        "FilterKey": "backupInterval",
        "FilterValue": "180",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-shanghai",
        "AutoCreated": false,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "copy",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "RetentionType": "delay",
        "StorageClass": "ARCHIVE"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "RetentionValue": "365",
        "BakType": "F",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DestType": "level1",
        "FilterType": "Crontab",
        "SrcRegion": "cn-hangzhou",
        "AutoCreated": true,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "Copy",
        "PolicyId": "smp-8sv763r9boydzb***",
        "DestRegion": "cn-hangzhou",
        "RetentionType": "Delay"
      }
    ],
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "BackupMethod": "Physical",
    "BackupPriority": 1,
    "EnableIncBackup": true
  },
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

错误码

HTTP status code

错误码

错误信息

描述
403 Request.Forbidden Have no Permissions 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

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

上一篇：DescribeBackupPolicy - 查询备份策略下一篇：版本说明