調(diào)用DescribeCrossRegionBackupDBInstance接口查詢所選地域的哪些實例開啟了跨地域備份，以及這些實例的跨地域備份設(shè)置。
僅適用于如下實例類型：
- RDS MySQL：支持的實例版本請參見MySQL跨地域備份。
- RDS SQL Server：支持的實例版本請參見SQL Server跨地域備份。
- RDS PostgreSQL ：支持的實例版本請參見PostgreSQL跨地域備份。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeCrossRegionBackupDBInstance |
系統(tǒng)規(guī)定參數(shù)，取值：DescribeCrossRegionBackupDBInstance。 |
| RegionId | String | 是 | cn-hangzhou |
地域ID。 |
| DBInstanceId | String | 否 | rm-uf6wjk5xxxxxxxxxx |
實例ID。一次最多傳入30個實例ID，以英文逗號（,）分隔。 |
| PageSize | Integer | 否 | 30 |
每頁記錄數(shù)。默認值：30。 |
| PageNumber | Integer | 否 | 1 |
頁碼，取值：大于0且不超過Integer的最大值。 默認值：1。 |
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RegionId | String | cn-hangzhou |
地域ID。 |
| TotalRecords | Integer | 100 |
總記錄數(shù)。 |
| ItemsNumbers | Integer | 1 |
跨地域備份設(shè)置列表內(nèi)的Item數(shù)量。 |
| PageNumber | Integer | 1 |
頁碼，取值：大于0且不超過Integer的最大值。 默認值：1。 |
| PageSize | Integer | 30 |
每頁記錄數(shù)。默認值：30。 |
| RequestId | String | 33517002-182D-40BE-93EC-610BD3381045 |
請求ID。 |
| Items | Array of Item |
跨地域備份設(shè)置列表。 |
|
| Item | |||
| BackupEnabled | String | Enable |
跨地域備份總開關(guān)，取值：
|
| BackupEnabledTime | String | 2019-06-12T05:44:21Z |
跨地域數(shù)據(jù)備份開啟時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 |
| CrossBackupRegion | String | cn-shanghai |
跨地域備份目的地域ID。 |
| CrossBackupType | String | 1 |
跨地域備份保存類型。默認值：1，表示每個備份都保存。 |
| DBInstanceDescription | String | 測試數(shù)據(jù)庫 |
實例名稱，長度為2~256個字符。以中文、英文字母開頭，可以包含數(shù)字、中文、英文、下劃線（_）、短橫線（-）。 說明 不能以 http:// 和 https:// 開頭。
|
| DBInstanceId | String | rm-uf6wjk5xxxxxxxxxx |
實例ID。 |
| DBInstanceStatus | String | Running |
實例狀態(tài)，詳情請參見實例狀態(tài)表。 |
| Engine | String | MySQL |
數(shù)據(jù)庫類型。 |
| EngineVersion | String | 5.6 |
數(shù)據(jù)庫版本。 |
| LockMode | String | Unlock |
實例鎖定狀態(tài)，取值：
|
| LogBackupEnabled | String | Enable |
跨地域日志備份開關(guān)，取值：
|
| LogBackupEnabledTime | String | 2019-06-12T05:44:21Z |
跨地域日志備份開啟時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 |
| RetentType | Integer | 1 |
跨地域備份保留方式。當前僅支持按配置時長保留，默認值：1。 |
| Retention | Integer | 15 |
跨地域備份保留天數(shù)，取值：7~1825。 |
示例
請求示例
http(s)://rds.aliyuncs.com/?Action=DescribeCrossRegionBackupDBInstance
&RegionId=cn-hangzhou
&<公共請求參數(shù)>正常返回示例
XML格式
<DescribeCrossRegionBackupDBInstanceResponse>
<Items>
<Item>
<LockMode>Unlock</LockMode>
<CrossBackupType>1</CrossBackupType>
<LogBackupEnabled>Enable</LogBackupEnabled>
<BackupEnabledTime>2019-06-12T05:44:21Z</BackupEnabledTime>
<BackupEnabled>Enable</BackupEnabled>
<RetentType>1</RetentType>
<DBInstanceId>rm-bpxxxxx</DBInstanceId>
<Retention>15</Retention>
<DBInstanceDescription>測試數(shù)據(jù)庫</DBInstanceDescription>
<Engine>MySQL</Engine>
<LogBackupEnabledTime>2019-06-12T05:44:21Z</LogBackupEnabledTime>
<CrossBackupRegion>cn-shanghai</CrossBackupRegion>
<EngineVersion>5.6</EngineVersion>
<DBInstanceStatus>Running</DBInstanceStatus>
</Item>
</Items>
<PageNumber>1</PageNumber>
<RegionId>cn-hangzhou</RegionId>
<RequestId>33517002-182D-40BE-93EC-610BD3381045</RequestId>
<ItemsNumbers>1</ItemsNumbers>
<TotalRecords>1</TotalRecords>
</DescribeCrossRegionBackupDBInstanceResponse>JSON格式
{
"Items": {
"Item": [
{
"LockMode": "Unlock",
"CrossBackupType": "1",
"LogBackupEnabled": "Enable",
"BackupEnabledTime": "2019-06-12T05:44:21Z",
"BackupEnabled": "Enable",
"RetentType": 1,
"DBInstanceId": "rm-bpxxxxx",
"Retention": 15,
"DBInstanceDescription": "測試數(shù)據(jù)庫",
"Engine": "MySQL",
"LogBackupEnabledTime": "2019-06-12T05:44:21Z",
"CrossBackupRegion": "cn-shanghai",
"EngineVersion": "5.6",
"DBInstanceStatus": "Running"
}
]
},
"PageNumber": 1,
"RegionId": "cn-hangzhou",
"RequestId": "33517002-182D-40BE-93EC-610BD3381045",
"ItemsNumbers": 1,
"TotalRecords": 1
}錯誤碼
| HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 當前DB實例引擎不支持此操作。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的region不合法 |
訪問錯誤中心查看更多錯誤碼。