ModifyBackupPolicy - 修改备份策略_数据管理 DMS-阿里云帮助中心

修改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	否
DestType	string	否
FilterType	string	否
ActionType	string	否
SrcRegion	string	否
EnableLogBackup	integer	否
SrcType	string	否
LogRetentionValue	string	否
PolicyId	string	否
FilterKey	string	否
DestRegion	string	否
FilterValue	string	否
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	否	一天之前的高频备份集，是否只保留每天一个
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	否
AdvanceIncPolicies	array<object>	否
	object	否
DestType	string	否
FilterType	string	否
ActionType	string	否
SrcRegion	string	否
SrcType	string	否
OnlyPreserveOneEachDay	boolean	否
RetentionValue	string	否
PolicyId	string	否
FilterKey	string	否
DestRegion	string	否
FilterValue	string	否
RetentionType	string	否
BackupRetentionPolicyOnClusterDeletion	string	否
BackupMethod	string	否
BackupPriority	integer	否
EnableIncBackup	boolean	否

返回参数

名称	类型	描述	示例值
	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
DestType	string
FilterType	string
SrcRegion	string
EnableLogBackup	integer
SrcType	string
PolicyId	string
DestRegion	string
LogRetentionValue	string
FilterKey	string
FilterValue	string
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
AdvanceIncPolicies	array<object>
	object
RetentionValue	string
BakType	string
FilterKey	string
FilterValue	string
DestType	string
FilterType	string
SrcRegion	string
AutoCreated	boolean
SrcType	string
OnlyPreserveOneEachDay	boolean
DumpAction	string
PolicyId	string
DestRegion	string
RetentionType	string
BackupRetentionPolicyOnClusterDeletion	string
BackupMethod	string
BackupPriority	integer
EnableIncBackup	boolean
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": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "PolicyId": "",
        "DestRegion": "",
        "LogRetentionValue": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ],
    "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": ""
      }
    ],
    "AdvanceIncPolicies": [
      {
        "RetentionValue": "",
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "AutoCreated": true,
        "SrcType": "",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "",
        "PolicyId": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ],
    "BackupRetentionPolicyOnClusterDeletion": "",
    "BackupMethod": "",
    "BackupPriority": 0,
    "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控制台进行授权后再执行操作

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

变更历史

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