文档

ModifyBackupPolicy - 修改备份策略

更新时间:
一键部署

修改PolarDB实例备份策略。

接口说明

适用引擎

PolarDB MySQL 版

说明 当前该接口仅针对特定客户开放使用,如有需求,请到 DBS 客户咨询群(钉钉群号:35585947)申请使用。

调试

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

授权信息

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

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

请求参数

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

备份集所在地域。

cn-shanghai
PreferredBackupWindowBeginstring

基础备份窗口开始时间。

17:00Z
InstanceNamestring

PolarDB 实例 ID。

pc-2ze3nrr64c5****
AdvanceDataPoliciesarray<object>

数据备份策略详情。

object

策略详情。

ActionTypestring

操作类型,取值如下:

  • CREATE:新增
  • UPDATE:修改
  • DELETE:删除
UPDATE
PolicyIdstring

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

6s67c7i3y8f8p72808p******
FilterTypestring

高级策略筛选类型,取值如下:

  • crontab:周期调度
  • event:事件调度
crontab
FilterKeystring

调度类型,取值如下:

  • dayOfWeek:按周调度
  • dayOfMonth:按月调度
  • dayOfYear:按年调度
  • backupInterval:固定间隔调度
说明 仅当 FilterType 为 crontab 时,返回该参数。
backupInterval
FilterValuestring

备份周期。

180
RetentionTypestring

备份集保留周期类型,取值如下:

  • never:永不过期
  • delay:固定天数过期
delay
RetentionValuestring

过期天数。

4
SrcTypestring

备份策略源类型,取值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
db
SrcRegionstring

备份策略源地域。

cn-shanghai
DestTypestring

备份策略目标类型,取值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
level1
DestRegionstring

备份策略目标地域。

cn-shanghai

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

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

返回信息。

instanceName can not be empty.
Dataobject

备份策略详情。

PreferredBackupWindowBeginstring

基础备份窗口开始时间。

17:00Z
PreferredBackupWindowstring

基础备份窗口。

17:00Z-18:00Z
AdvanceDataPoliciesarray<object>

数据备份策略详情。

AdvanceDataPolicieobject

策略详情。

PolicyIdstring

高级策略 ID。

dc13b153acc91141789122c23835****
FilterTypestring

高级策略筛选类型,返回值如下:

  • crontab:周期调度
  • event:事件调度
crontab
FilterKeystring

调度类型,返回值如下:

  • dayOfWeek:按周调度
  • dayOfMonth:按月调度
  • dayOfYear:按年调度
  • backupInterval:固定间隔调度
说明 仅当 FilterType 为 crontab 时,返回该参数。
backupInterval
FilterValuestring

备份周期。

180
DumpActionstring

转储策略详情,返回值如下:

  • copy:复制
  • move:转储
copy
RetentionTypestring

备份集保留周期类型,返回值如下:

  • never:永不过期
  • delay:固定天数过期
delay
RetentionValuestring

过期天数。

4
SrcTypestring

备份策略源类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
db
SrcRegionstring

备份策略源地域。

cn-shanghai
DestTypestring

备份策略目标类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
level1
DestRegionstring

备份策略目标地域。

cn-shanghai
BakTypestring

备份类型,返回值如下:

  • F:全量备份
  • L:日志备份
F
AutoCreatedboolean

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

  • true:系统生成策略
  • false:用户自定义策略
false
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Codestring

状态码。

Success
Successstring

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrCodestring

错误码。

Success

示例

正常返回示例

JSON格式

{
  "RequestId": "D570F209-A166-50C6-98A3-155A20B218B7",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupWindowBegin": "17:00Z",
    "PreferredBackupWindow": "17:00Z-18:00Z",
    "Category": "",
    "AdvanceDataPolicies": [
      {
        "PolicyId": "dc13b153acc91141789122c23835****",
        "FilterType": "crontab",
        "FilterKey": "backupInterval",
        "FilterValue": "180",
        "DumpAction": "copy",
        "RetentionType": "delay",
        "RetentionValue": "4",
        "SrcType": "db",
        "SrcRegion": "cn-shanghai",
        "DestType": "level1",
        "DestRegion": "cn-shanghai",
        "BakType": "F",
        "AutoCreated": false,
        "OnlyPreserveOneEachDay": true
      }
    ]
  },
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
2024-09-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-28API 内部配置变更,不影响调用查看变更详情