查詢已被釋放的PolarDB叢集中備份組詳情。
介面說明
調用本介面時,PolarDB 叢集需處於已釋放狀態,且叢集釋放時選擇長期保留全部備份或長期保留最後一個備份(刪除前自動備份)。若叢集釋放後所保留的備份組全部被主動刪除,則此介面也無法再查詢到該叢集。
您可以調用 DescribeDBClusterAttribute 介面查詢叢集狀態。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardb:DescribeDetachedBackups |
get |
*dbcluster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBClusterId |
string |
是 |
叢集 ID。 |
pc-**************** |
| BackupId |
string |
否 |
備份 ID。 |
111111111 |
| BackupStatus |
string |
否 |
備份狀態,取值範圍如下:
|
Success |
| BackupMode |
string |
否 |
備份模式,取值範圍如下:
|
Manual |
| BackupRegion |
string |
否 |
跨地區備份的目的地區。 說明
當前僅 PolarDB MySQL 版支援該參數。 |
cn-hangzhou |
| StartTime |
string |
是 |
查詢開始時間,格式為 |
2020-05-01T00:00Z |
| EndTime |
string |
是 |
查詢結束時間,查詢結束時間需晚於開始時間,格式為 |
2020-05-14T00:00Z |
| PageSize |
integer |
否 |
每頁記錄數,取值範圍如下:
預設值為 30。 |
30 |
| PageNumber |
integer |
否 |
頁碼,取值範圍為大於 0 但不超過 Integer 最大值的整數,預設值為 1。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| TotalRecordCount |
string |
總記錄數。 |
50 |
| PageRecordCount |
string |
本頁記錄數。 |
15 |
| RequestId |
string |
請求 ID。 |
717B2382-BB14-4DCB-BBC2-32DBE0****** |
| PageNumber |
string |
頁碼。 |
1 |
| Items |
object |
||
| Backup |
array<object> |
備份組詳情。 |
|
|
object |
|||
| BackupSetSize |
string |
備份檔案大小,單位為 Byte。 說明
因為快照之間存在共用資料區塊,因此刪除目標快照備份後釋放的空間會遠小於該備份檔案的大小。 |
7251056 |
| ConsistentTime |
string |
一致性快照的時間點,格式為 Unix 時間戳記,單位為秒。 |
1589253947 |
| StoreStatus |
string |
是否允許刪除備份組,取值範圍如下:
|
Disabled |
| BackupStatus |
string |
備份狀態,取值範圍如下:
|
Success |
| BackupType |
string |
備份類型,僅支援全量備份,取值固定為 FullBackup。 |
FullBackup |
| BackupStartTime |
string |
本次備份開始時間(UTC 時間)。 |
2020-05-12T03:25:44Z |
| IsAvail |
string |
備份組是否可用,取值範圍如下:
|
1 |
| BackupEndTime |
string |
本次備份結束時間(UTC 時間)。 |
2020-05-12T03:25:55Z |
| BackupId |
string |
備份 ID。 |
111111111 |
| DBClusterId |
string |
叢集 ID。 |
pc-************** |
| BackupsLevel |
string |
備份組層級,取值範圍如下:
|
Level-2 |
| BackupMode |
string |
備份模式,取值範圍如下:
|
Manual |
| BackupMethod |
string |
資料備份方法,僅支援快照備份,取值固定為 Snapshot 。 |
Snapshot |
樣本
正常返回樣本
JSON格式
{
"TotalRecordCount": "50",
"PageRecordCount": "15",
"RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
"PageNumber": "1",
"Items": {
"Backup": [
{
"BackupSetSize": "7251056",
"ConsistentTime": "1589253947",
"StoreStatus": "Disabled",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-05-12T03:25:44Z",
"IsAvail": "1",
"BackupEndTime": "2020-05-12T03:25:55Z",
"BackupId": "111111111",
"DBClusterId": "pc-**************",
"BackupsLevel": "Level-2",
"BackupMode": "Manual",
"BackupMethod": "Snapshot"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | |
| 400 | InvalidBackupStatus.Malformed | The specified parameter BackupStatus is not valid. | 指定的參數BackupStatus無效 |
| 400 | InvalidBackupMode.Malformed | The specified parameter BackupMode is not valid. | 指定的參數BackupMode無效 |
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的參數StartTime無效 |
| 400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | 指定的參數EndTime無效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的參數PageSize無效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的參數PageNumber無效 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數DBClusterId無效 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。