調用DescribeCrossRegionBackupDBInstance介面查詢所選地區的哪些執行個體開啟了跨地區備份,以及這些執行個體的跨地區備份設定。
僅適用於如下執行個體:
- MySQL 5.7高可用本地SSD盤版
- MySQL 5.6
調試
前往【API Explorer】線上調試,API Explorer 提供線上調用 API、動態產生 SDK Example 代碼和快速檢索介面等能力,能顯著降低使用雲 API 的難度,強烈推薦使用。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCrossRegionBackupDBInstance |
系統規定參數,取值:DescribeCrossRegionBackupDBInstance。 |
RegionId | String | 是 | cn-hangzhou |
地區ID。 |
AccessKeyId | String | 否 | LTAIfCxxxxxxx |
阿里雲頒發給使用者的訪問服務所用的密鑰ID。 |
PageNumber | Integer | 否 | 1 |
頁碼,取值:大於0且不超過Integer的最大值。 預設值:1。 |
PageSize | Integer | 否 | 30 |
每頁記錄數,取值:
預設值:30。 |
DBInstanceId | String | 否 | rm-uf6wjk5xxxxxxxxxx |
執行個體ID。一次最多傳入30個執行個體ID,以英文逗號(,)分隔。 |
返回參數
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
RegionId | String | cn-hangzhou |
地區ID。 |
TotalRecords | Integer | 100 |
總記錄數。 |
ItemsNumbers | Integer | 1 |
跨地區備份設定列表內的Item數量。 |
PageNumber | Integer | 1 |
頁碼,取值:大於0且不超過Integer的最大值。 預設值:1。 |
PageSize | Integer | 30 |
每頁記錄數,取值:
預設值:30。 |
RequestId | String | 33517002-182D-40BE-93EC-610BD3381045 |
請求ID。 |
Items |
跨地區備份設定列表。 |
||
└BackupEnabled | String | 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 |
執行個體鎖定狀態,取值:
|
└LogBackupEnabled | String | Enable |
跨地區記錄備份開關,取值:
|
└LogBackupEnabledTime | String | 2019-06-12T05:44:21Z |
跨地區記錄備份開啟時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
└RetentType | Integer | 1 |
跨地區備份保留方式。當前僅支援按配置時間長度保留,預設值:1。 |
└Retention | Integer | 15 |
跨地區備份保留天數,取值:7~1825。 |
樣本
請求樣本
http(s)://rds.aliyuncs.com/?Action=DescribeCrossRegionBackupDBInstance
&RegionId=cn-hangzhou
&<公用請求參數>
正常返回樣本
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>測試資料庫</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":"測試資料庫",
"Engine":"MySQL",
"LogBackupEnabledTime":"2019-06-12T05:44:21Z",
"CrossBackupRegion":"cn-shanghai",
"EngineVersion":"5.6",
"DBInstanceStatus":"Running"
}
]
},
"PageNumber":1,
"RequestId":"33517002-182D-40BE-93EC-610BD3381045",
"RegionId":"cn-hangzhou",
"ItemsNumbers":1,
"TotalRecords":1
}