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

仅适用于如下实例类型:

调试

您可以在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:开启
说明 开启跨地域备份时,必须传入目的地域ID。
CrossBackupRegion String cn-shanghai

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

RetentType Integer 1

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

Retention Integer 7

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

返回数据

名称 类型 示例值 描述
BackupEnabled String Enable

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

  • Disable:关闭
  • Enable:开启
RegionId String cn-hangzhou

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

LogBackupEnabled String Enable

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

  • Disable:关闭
  • Enable:开启
RequestId String 50A6059D-6DBB-46C6-A851-1EE93C9013CF

请求ID。

RetentType Integer 1

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

CrossBackupRegion String cn-shanghai

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

CrossBackupType String 1

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

Retention Integer 15

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

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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格式

HTTP/1.1 200 OK
Content-Type:application/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. 还原时间或备份集不能同时为空,请设置后重试。
400 InvalidRegion.Format Specified Region is not valid. 指定的地域不合法,请检查该参数的正确性。
400 OperationDenied.SwitchToCrossRegionBackup Snapshot backup does not support cross region backup storage at present. 操作失败,快照备份目前不支持跨区域备份存储。
400 OperationDenied.SwitchToSnapshot Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. 操作失败,快照备份目前不支持跨区域存储。在切换到快照备份模式之前,请关闭跨区域备份。
400 OperationDenied.SwitchSnapshotToPhysical Only physical backup to snapshot backup is supported. 当前操作仅支持物理备份到快照备份。
403 IncorrectEngineVersion Current engine version does not support operations. 操作失败,当前数据库版本不支持此操作。
403 IncorrectDBInstanceType Current DB instance type does not support this operation. 操作失败,该实例状态下不支持此操作。
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 操作失败,数据库引擎不支持。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 操作失败,实例处于锁定状态。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 操作失败,该实例状态下不支持此操作。
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. 指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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