该接口用于查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
- RDS MySQL跨地域备份
- RDS PostgreSQL跨地域备份
- RDS SQL Server跨地域备份
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeCrossRegionBackupDBInstance | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 |
地域ID。 |
cn-hangzhou |
| DBInstanceId | string | 否 |
实例ID。一次最多传入30个实例ID，以英文逗号（,）分隔。 |
rm-uf6wjk5**** |
| PageSize | integer | 否 |
每页记录数。默认值：30。 |
30 |
| PageNumber | integer | 否 |
页码，取值：大于0且不超过Integer的最大值。 默认值：1。 |
1 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
33517002-182D-40BE-93EC-610BD3381045 |
| TotalRecords | integer |
总记录数。 |
100 |
| ItemsNumbers | integer |
跨地域备份设置列表内的Item数量。 |
1 |
| PageSize | integer |
每页记录数。默认值：30。 |
30 |
| PageNumber | integer |
页码，取值：大于0且不超过Integer的最大值。 默认值：1。 |
1 |
| RegionId | string |
地域ID。 |
cn-hangzhou |
| Items | object [] |
跨地域备份设置列表。 |
|
| LogBackupEnabledTime | string |
跨地域日志备份开启时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
2019-06-12T05:44:21Z |
| BackupEnabled | string |
跨地域备份总开关，取值：
|
Enable |
| DBInstanceStatus | string |
实例状态，详情请参见实例状态表。 |
Running |
| LockMode | string |
实例锁定状态，取值：
|
Unlock |
| EngineVersion | string |
数据库版本。 |
5.6 |
| LogBackupEnabled | string |
跨地域日志备份开关，取值：
|
Enable |
| RetentType | integer |
跨地域备份保留方式。当前仅支持按配置时长保留，默认值：1。 |
1 |
| Retention | integer |
跨地域备份保留天数，取值：7~1825。 |
15 |
| CrossBackupType | string |
跨地域备份保存类型。默认值：1，表示每个备份都保存。 |
1 |
| CrossBackupRegion | string |
跨地域备份目的地域ID。 |
cn-shanghai |
| DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
| Engine | string |
数据库类型。 |
MySQL |
| BackupEnabledTime | string |
跨地域数据备份开启时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
2019-06-12T05:44:21Z |
| DBInstanceDescription | string |
实例名称，长度为2~256个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。 说明 | testdb |
示例
正常返回示例
JSON格式
{
"RequestId": "33517002-182D-40BE-93EC-610BD3381045",
"TotalRecords": 100,
"ItemsNumbers": 1,
"PageSize": 30,
"PageNumber": 1,
"RegionId": "cn-hangzhou",
"Items": {
"Item": [
{
"LogBackupEnabledTime": "2019-06-12T05:44:21Z",
"BackupEnabled": "Enable",
"DBInstanceStatus": "Running",
"LockMode": "Unlock",
"EngineVersion": "5.6",
"LogBackupEnabled": "Enable",
"RetentType": 1,
"Retention": 15,
"CrossBackupType": "1",
"CrossBackupRegion": "cn-shanghai",
"DBInstanceId": "rm-uf6wjk5****",
"Engine": "MySQL",
"BackupEnabledTime": "2019-06-12T05:44:21Z",
"DBInstanceDescription": "testdb"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameters.Format | Specified parameter is not valid. | – |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地域不合法，请检查该参数的正确性。 |
| 403 | CrossBackupNotSupport | Specified region not support cross region backup. | 指定的区域不支持跨区域备份。 |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败，数据库引擎不支持。 |
| 404 | InvalidPage.notFound | Page not found. | 指定参数未找到，请检查确认参数。 |
| 404 | InvalidUser.NotFound | Specified user does not exist. | 指定用户不存在。请检查用户信息是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156540.html