DescribeInstanceCrossBackupPolicy - 查询跨地域备份设置

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

接口说明

仅适用于如下实例类型：

RDS MySQL：支持的实例版本请参见MySQL跨地域备份。
RDS SQL Server：支持的实例版本请参见SQL Server跨地域备份。
RDS PostgreSQL ：支持的实例版本请参见PostgreSQL跨地域备份。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeInstanceCrossBackupPolicy	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例ID。	rm-uf6wjk5xxxxxxxxxx
RegionId	string	是	地域ID，可以通过接口DescribeRegions查看地域ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
LogBackupEnabledTime	string	跨地域日志备份开启时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-06-12T05:44:21Z
BackupEnabled	string	跨地域备份总开关，取值： Disable：关闭 Enable：开启	Enable
DBInstanceStatus	string	实例状态。详情请参见实例状态表。	Running
LockMode	string	实例锁定状态，取值： Unlock：正常，没有锁定。 ManualLock：手动触发锁定。 LockByExpiration：实例过期自动锁定。 LockByRestoration：实例回滚前的自动锁定。 LockByDiskQuota：实例空间满自动锁定，不可访问实例。	Unlock
EngineVersion	string	数据库版本。	5.6
RegionId	string	实例所在地域ID。	cn-hangzhou
LogBackupEnabled	string	跨地域日志备份开关，取值： Disable：关闭 Enable：开启	Enable
RequestId	string	请求ID。	CB7667B2-72C8-497B-9BD8-3B343CEF51AB
RetentType	integer	跨地域备份保留方式。默认值：1，表示按时长保留。	1
Retention	integer	跨地域备份保留天数，取值：7~1825。	15
CrossBackupRegion	string	跨地域备份的目的地域ID。	cn-shanghai
CrossBackupType	string	跨地域备份保存类型。默认值：1，表示每个备份都保存。	1
DBInstanceId	string	实例ID。	rm-uf6wjk5xxxxxxxxxx
Engine	string	数据库类型。	mysql
DBInstanceDescription	string	实例名称，长度为2~256个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。说明不能以 http:// 和 https:// 开头。	测试数据库
BackupEnabledTime	string	跨地域备份开启时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-06-12T05:44:21Z

示例

正常返回示例

JSON格式

{
  "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
  "BackupEnabled": "Enable",
  "DBInstanceStatus": "Running",
  "LockMode": "Unlock",
  "EngineVersion": "5.6",
  "RegionId": "cn-hangzhou",
  "LogBackupEnabled": "Enable",
  "RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
  "RetentType": 1,
  "Retention": 15,
  "CrossBackupRegion": "cn-shanghai",
  "CrossBackupType": "1",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "Engine": "mysql",
  "DBInstanceDescription": "测试数据库",
  "BackupEnabledTime": "2019-06-12T05:44:21Z"
}

JSON格式

{
  "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
  "BackupEnabled": "Enable",
  "DBInstanceStatus": "Running",
  "LockMode": "Unlock",
  "EngineVersion": "5.6",
  "RegionId": "cn-hangzhou",
  "LogBackupEnabled": "Enable",
  "RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
  "RetentType": 1,
  "Retention": 15,
  "CrossBackupRegion": "cn-shanghai",
  "CrossBackupType": "1",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "Engine": "mysql",
  "DBInstanceDescription": "测试数据库",
  "BackupEnabledTime": "2019-06-12T05:44:21Z"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegion.Format	Specified Region is not valid.	指定的地域不合法，请检查该参数的正确性。
403	CrossBackupNotSupport	Specified region not support cross region backup.	指定的区域不支持跨区域备份。
404	not found	Page not found.	-

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

变更历史

变更时间

变更内容概要

操作

2022-09-01

OpenAPI 错误码发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	错误码 404 变更
	删除错误码：400
	删除错误码：403