调用DescribeInstanceCrossBackupPolicy接口查询跨地域备份设置。

仅适用于如下实例:

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

调试

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

请求参数

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

系统规定参数,取值:DescribeInstanceCrossBackupPolicy

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

RegionId String cn-hangzhou

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

返回数据

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

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

  • Disable:关闭
  • Enable:开启
BackupEnabledTime String 2019-06-12T05:44:21Z

跨地域备份开启时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

CrossBackupRegion String cn-shanghai

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

CrossBackupType String 1

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

DBInstanceDescription String 测试数据库

实例名称,长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。

说明 不能以 http:// 和 https:// 开头。
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

DBInstanceStatus String Running

实例状态。详情请参见实例状态表

Engine String MySQL

数据库类型。

EngineVersion String 5.6

数据库版本。

LockMode String Unlock

实例锁定状态,取值:

  • Unlock:正常,没有锁定。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前的自动锁定。
  • LockByDiskQuota:实例空间满自动锁定,不可访问实例。
LogBackupEnabled String Enable

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

  • Disable:关闭
  • Enable:开启
LogBackupEnabledTime String 2019-06-12T05:44:21Z

跨地域日志备份开启时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

RegionId String cn-hangzhou

实例所在地域ID。

RequestId String CB7667B2-72C8-497B-9BD8-3B343CEF51AB

请求ID。

RetentType Integer 1

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

Retention Integer 15

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

示例

请求示例

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

正常返回示例

XML 格式

<DescribeInstanceCrossBackupPolicyResponse>
  <DBInstanceStatusDesc>ACTIVATION</DBInstanceStatusDesc>
	  <LockMode>Unlock</LockMode>
	  <BackupEnabledTime>2019-06-12T05:44:21Z</BackupEnabledTime>
	  <CrossBackupType>1</CrossBackupType>
	  <LogBackupEnabled>Enable</LogBackupEnabled>
	  <BackupEnabled>Enable</BackupEnabled>
	  <RetentType>1</RetentType>
	  <DBInstanceId>rm-bpxxxxx</DBInstanceId>
	  <DBInstanceDescription></DBInstanceDescription>
	  <Retention>15</Retention>
	  <Engine>mysql</Engine>
	  <LogBackupEnabledTime>2019-06-12T05:44:21Z</LogBackupEnabledTime>
	  <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
	  <StorageOwner>rds</StorageOwner>
	  <RegionId>cn-hangzhou</RegionId>
	  <RequestId>CB7667B2-72C8-497B-9BD8-3B343CEF51AB</RequestId>
	  <EngineVersion>5.6</EngineVersion>
	  <StorageType>oss</StorageType>
	  <Endpoint></Endpoint>
	  <DBInstanceStatus>1</DBInstanceStatus>
</DescribeInstanceCrossBackupPolicyResponse>

JSON 格式

{
	"DBInstanceStatusDesc": "ACTIVATION",
	"LockMode": "Unlock",
	"BackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupType": "1",
	"LogBackupEnabled": "Enable",
	"BackupEnabled": "Enable",
	"RetentType": 1,
	"DBInstanceId": "rm-bpxxxxx",
	"DBInstanceDescription": "",
	"Retention": 15,
	"Engine": "mysql",
	"LogBackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupRegion": "cn-shanghai",
	"StorageOwner": "rds",
	"RegionId": "cn-hangzhou",
	"RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
	"EngineVersion": "5.6",
	"StorageType": "oss",
	"Endpoint": "",
	"DBInstanceStatus": "1"
}

错误码

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