调用ModifyInstanceCrossBackupPolicy接口修改RDS跨地域备份设置。

仅适用于如下实例:

  • MySQL 8.0高可用版(本地SSD盘)
  • MySQL 5.7高可用版(本地SSD盘)
  • MySQL 5.6

调试

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

请求参数

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

系统规定参数,取值:ModifyInstanceCrossBackupPolicy

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

RegionId String cn-hangzhou

源实例地域ID,可以通过接口DescribeRegions查看地域ID。

CrossBackupType String 1

跨地域备份保存类型。当前唯一取值:1,表示每个备份都保存。

LogBackupEnabled String 1

跨地域日志备份开关,取值:

  • 0:关闭
  • 1:开启
BackupEnabled String 1

跨地域备份总开关(数据备份+日志备份),取值:

  • 0:关闭
  • 1:开启
CrossBackupRegion String cn-shanghai

跨地域备份的目的地域ID。

RetentType Integer 1

跨地域备份保留方式。当前唯一取值:1,表示按时长保留。

Retention Integer 7

跨地域备份保留天数,取值:7~1825

返回数据

名称 类型 示例值 描述
RequestId String 50A6059D-6DBB-46C6-A851-1EE93C9013CF

请求ID。

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

RegionId String cn-hangzhou

源实例地域ID,可以通过接口DescribeRegions查看地域ID。

CrossBackupRegion String cn-shanghai

跨地域备份的目的地域ID。

CrossBackupType String 1

跨地域备份保存类型。默认值:1,表示每个备份都保存。

BackupEnabled String 1

跨地域备份总开关,取值:

  • 0:关闭
  • 1:开启
LogBackupEnabled String 1

跨地域日志备份开关,取值:

  • 0:关闭
  • 1:开启
RetentType Integer 1

跨地域备份保留方式。默认值:1,表示按时长保留。

Retention Integer 15

跨地域备份保留天数,取值:7~1825

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ModifyInstanceCrossBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<ModifyInstanceCrossBackupPolicyResponse>
  <CrossBackupType>1</CrossBackupType>
	  <LogBackupEnabled>Enable</LogBackupEnabled>
	  <BackupEnabled>Enable</BackupEnabled>
	  <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
	  <RetentType>1</RetentType>
	  <RequestId>50A6059D-6DBB-46C6-A851-1EE93C9013CF</RequestId>
	  <DBInstanceId>rm-bpxxxxx</DBInstanceId>
	  <RegionId>cn-hangzhou</RegionId>
	  <StorageType>oss</StorageType>
	  <Endpoint></Endpoint>
	  <Retention>15</Retention>
</ModifyInstanceCrossBackupPolicyResponse>

JSON 格式

{
    "CrossBackupType": "1",
    "LogBackupEnabled": "Enable",
    "BackupEnabled": "Enable",
    "CrossBackupRegion": "cn-shanghai",
    "RetentType": 1,
    "RequestId": "50A6059D-6DBB-46C6-A851-1EE93C9013CF",
    "DBInstanceId": "rm-bpxxxxx",
    "RegionId": "cn-hangzhou",
    "StorageType": "oss",
    "Endpoint": "",
    "Retention": 15
}

错误码

HttpCode 错误码 错误信息 描述
400 ParameterLeastAssociate Must input at least one optional parameter. 必须至少输入一个可选参数。克隆的时候,克隆时间或者备份集,必须选其一。
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 当前DB实例引擎不支持此操作。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 当前DB实例锁模式不支持此操作。

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