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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateBackupPolicy

系统规定参数。取值:UpdateBackupPolicy

RegionId String cn-hangzhou

地域ID。

DBInstanceName String pxc-hzjasdyuoo

实例名称ID。

BackupPeriod String 1001000

备份周期。至少需要指定2天,7位数数值,从左到右每一位数值代表周一到周日是否开启备份。取值0代表不备份,取值1代表备份:

  • 第一位数值:周一
  • 第二位数值:周二
  • 第三位数值:周三
  • 第四位数值:周四
  • 第五位数值:周五
  • 第六位数值:周六
  • 第七位数值:周日
BackupPlanBegin String 03:00Z

每天备份开启时间,UTC时间。

BackupSetRetention Integer 30

备份集保留时间,单位天。

BackupType String 0

备份种类,目前只支持“0”,表示快速备份。

BackupWay String P

备份手段,枚举值

  • P:物理备份
  • L:逻辑备份
ForceCleanOnHighSpaceUsage Integer 1

当实例总空间使用率超过80%或剩余空间不足50 GB时,是否强制清理Binlog。从最早的开始清理,直到总空间使用率降到80%以下且剩余空间大于50 GB。取值如下:

  • 1:是
  • 0:否
IsEnabled Integer 1

是否开启备份,固定值1。

LocalLogRetention Integer 7

日志备份本地保留小时数, 范围为0到7×24小时, 0表示不保留,默认7小时。

RemoveLogRetention Integer 7

日志备份远程保留天数( 7~730) 单位天, 默认7天。

LogLocalRetentionSpace Integer 30

本地日志最大空间使用率,参数大小为0~50,此为循环空间,默认为30。

返回数据

名称 类型 示例值 描述
Message String success

返回信息,成功返回success,错误返回对应错误码。

RequestId String FEA5DC20-6D8A-5979-97AA-FC57546ADC20

请求ID。

Success Boolean true

请求是否成功。

Data Array of Account

返回的策略详情。

LogLocalRetentionSpace Integer 30

本地日志最大空间使用率,参数大小为0~50,此为循环空间,默认为30。

DBInstanceName String pxc-hzjasdyuoo

实例名称ID。

BackupWay String P

备份手段,枚举值:

  • P:物理备份
  • L:逻辑备份
BackupPeriod String 1001000

备份周期。

ForceCleanOnHighSpaceUsage Integer 1

是否强制清理Binlog。

BackupType String 0

备份类型,0表示快速备份。

LocalLogRetention Integer 7

日志备份本地保留小时数,取值范围为0到7×24小时,0表示不保留,默认7小时。

RemoveLogRetention Integer 7

日志备份远程保留天数( 7~730) 单位天, 默认7天。

BackupPlanBegin String 03:00Z

每天备份开启时间,UTC时间。

BackupSetRetention Integer 30

备份集保留时间,单位:天。

IsEnabled Integer 1

是否开启备份,固定值1。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateBackupPolicy
&RegionId=cn-hangzhou
&DBInstanceName=pxc-hzjasdyuoo
&BackupPeriod=1001000
&BackupPlanBegin=03:00Z
&BackupSetRetention=30
&BackupType=0
&BackupWay=P
&ForceCleanOnHighSpaceUsage=1
&IsEnabled=1
&LocalLogRetention=7
&RemoveLogRetention=7
&LogLocalRetentionSpace=30
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateBackupPolicyResponse>
    <Message>success</Message>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
    <Success>true</Success>
    <Data>
        <LogLocalRetentionSpace>30</LogLocalRetentionSpace>
        <DBInstanceName>pxc-hzjasdyuoo</DBInstanceName>
        <BackupWay>P</BackupWay>
        <BackupPeriod>1001000</BackupPeriod>
        <ForceCleanOnHighSpaceUsage>1</ForceCleanOnHighSpaceUsage>
        <BackupType>0</BackupType>
        <LocalLogRetention>7</LocalLogRetention>
        <RemoveLogRetention>7</RemoveLogRetention>
        <BackupPlanBegin>03:00Z</BackupPlanBegin>
        <BackupSetRetention>30</BackupSetRetention>
        <IsEnabled>1</IsEnabled>
    </Data>
</UpdateBackupPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Success" : true,
  "Data" : [ {
    "LogLocalRetentionSpace" : 30,
    "DBInstanceName" : "pxc-hzjasdyuoo",
    "BackupWay" : "P",
    "BackupPeriod" : "1001000",
    "ForceCleanOnHighSpaceUsage" : 1,
    "BackupType" : "0",
    "LocalLogRetention" : 7,
    "RemoveLogRetention" : 7,
    "BackupPlanBegin" : "03:00Z",
    "BackupSetRetention" : 30,
    "IsEnabled" : 1
  } ]
}

错误码

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