UpdateBackupPolicy - 修改实例备份策略 - 云原生数据库 PolarDB

调用UpdateBackupPolicy接口修改实例备份策略。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:UpdateBackupPolicy

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DBInstanceName	string	是	实例名称 ID。	pxc-hzjasdyuoo
BackupPeriod	string	否	备份周期。至少需要指定 2 天，7 位数数值，从左到右每一位数值代表周一到周日是否开启备份。取值 0 代表不备份，取值 1 代表备份：第一位数值：周一第二位数值：周二第三位数值：周三第四位数值：周四第五位数值：周五第六位数值：周六第七位数值：周日	1001000
BackupPlanBegin	string	否	每天备份开启时间，UTC 时间。	03:00Z
BackupSetRetention	integer	否	备份集保留时间，单位天。	30
BackupType	string	否	备份种类，目前只支持“0”，表示快速备份。	0
BackupWay	string	否	备份手段，枚举值 P：物理备份 L：逻辑备份	P
ForceCleanOnHighSpaceUsage	integer	否	当实例总空间使用率超过 80%或剩余空间不足 50 GB 时，是否强制清理 Binlog。从最早的开始清理，直到总空间使用率降到 80%以下且剩余空间大于 50 GB。取值如下： 1：是 0：否	1
IsEnabled	integer	否	是否开启备份，固定值 1，表示开启。	1
LocalLogRetention	integer	否	日志备份本地保留小时数，范围为 0 到 7×24 小时， 0 表示不保留，默认 7 小时。	7
RemoveLogRetention	integer	否	日志备份远程保留天数（ 7~730）单位天，默认 7 天。	7
LogLocalRetentionSpace	integer	否	本地日志最大空间使用率，参数大小为 0~50，此为循环空间，默认为 30。	30
ColdDataBackupInterval	integer	否	冷数据备份间隔天数，取值范围为 1~59。	30
ColdDataBackupRetention	integer	否	冷数据备份保留天数，取值范围为 30~730。	30
LocalLogRetentionNumber	integer	否	本地 Binlog 保留个数，默认为 60，取值范围为 6~100。	60
IsCrossRegionDataBackupEnabled	boolean	否	是否开启跨地域数据备份，默认为 false。	false
IsCrossRegionLogBackupEnabled	boolean	否	是否开启跨地域日志备份，默认为 false。	false
DestCrossRegion	string	否	跨地域备份的目标地域。	cn-shanghai
CrossRegionDataBackupRetention	integer	否	跨地域数据备份的保存时间，单位：天。	30
CrossRegionLogBackupRetention	integer	否	跨地域日志备份的保存时间，单位：天。	30
CrossRegionFilterValue	string	否

返回参数

名称	类型	描述	示例值
	object
Message	string	返回信息，成功返回 success，错误返回对应错误码。	success
RequestId	string	请求 ID。	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
Success	boolean	请求是否成功。	true
Data	object	返回的策略详情。
LogLocalRetentionSpace	integer
DBInstanceName	string
BackupWay	string
BackupPeriod	string
ForceCleanOnHighSpaceUsage	integer
BackupType	string
LocalLogRetention	integer
RemoveLogRetention	integer
BackupPlanBegin	string
BackupSetRetention	integer
IsEnabled	integer
ColdDataBackupInterval	integer
ColdDataBackupRetention	integer
LocalLogRetentionNumber	integer
IsCrossRegionDataBackupEnabled	boolean
IsCrossRegionLogBackupEnabled	boolean
DestCrossRegion	string
CrossRegionDataBackupRetention	integer
CrossRegionLogBackupRetention	integer
CrossRegionFilterValue	string

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Success": true,
  "Data": {
    "LogLocalRetentionSpace": 0,
    "DBInstanceName": "",
    "BackupWay": "",
    "BackupPeriod": "",
    "ForceCleanOnHighSpaceUsage": 0,
    "BackupType": "",
    "LocalLogRetention": 0,
    "RemoveLogRetention": 0,
    "BackupPlanBegin": "",
    "BackupSetRetention": 0,
    "IsEnabled": 0,
    "ColdDataBackupInterval": 0,
    "ColdDataBackupRetention": 0,
    "LocalLogRetentionNumber": 0,
    "IsCrossRegionDataBackupEnabled": true,
    "IsCrossRegionLogBackupEnabled": true,
    "DestCrossRegion": "",
    "CrossRegionDataBackupRetention": 0,
    "CrossRegionLogBackupRetention": 0,
    "CrossRegionFilterValue": ""
  }
}

错误码

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

变更历史

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