查詢PolarDB叢集的備份資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardb:DescribeBackups |
get |
*Backup
*DBCluster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBClusterId |
string |
是 |
叢集 ID。 |
pc-**************** |
| BackupId |
string |
否 |
備份 ID。 |
11111111 |
| BackupStatus |
string |
否 |
備份狀態，取值範圍如下：
|
Success |
| BackupMode |
string |
否 |
備份模式，取值範圍如下：
|
Automated |
| StartTime |
string |
是 |
查詢開始時間，格式為 |
2020-11-14T00:00Z |
| EndTime |
string |
是 |
查詢結束時間，查詢結束時間需晚於開始時間，格式為 |
2020-11-16T00:00Z |
| BackupRegion |
string |
否 |
跨地區備份的目的地區。 說明
當前僅 PolarDB MySQL 版支援該參數。 |
cn-hangzhou |
| PageSize |
integer |
否 |
每頁記錄數，取值範圍如下：
預設值為 30。 |
30 |
| PageNumber |
integer |
否 |
頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數，預設值為 1。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| TotalRecordCount |
string |
總記錄數。 |
1 |
| PageRecordCount |
string |
本頁記錄數。 |
1 |
| RequestId |
string |
請求 ID。 |
24A1990B-4F6E-482B-B8CB-75C612****** |
| PageNumber |
string |
頁碼。 |
1 |
| Items |
object |
||
| Backup |
array<object> |
備份組詳情。 |
|
|
object |
|||
| BackupSetSize |
string |
備份檔案大小，單位為 Byte。 說明
因為快照之間存在共用資料區塊，因此刪除目標快照備份後釋放的空間會遠小於該備份檔案的大小。更多詳情，請參見備份功能 FAQ。 |
4639948800 |
| ConsistentTime |
string |
一致性快照的時間點，格式為 Unix 時間戳記，單位為秒。 |
1605425407 |
| BackupStatus |
string |
備份狀態，取值範圍如下：
|
Success |
| BackupType |
string |
備份類型，僅支援全量備份，取值固定為 FullBackup。 |
FullBackup |
| BackupStartTime |
string |
本次備份開始時間（UTC 時間）。 |
2020-11-15T07:30:05Z |
| ExpectExpireTime |
string |
備份組預期到期時間（僅支援開啟稀疏備份的執行個體） |
2022-10-24T08:13:23Z |
| ExpectExpireType |
string |
備份組預期到期類型（僅支援開啟稀疏備份的執行個體） 枚舉值：
|
EXPIRED |
| IsAvail |
string |
備份組是否可用，取值範圍如下：
|
0 |
| BackupEndTime |
string |
本次備份結束時間（UTC 時間）。 |
2020-11-15T07:30:20Z |
| BackupId |
string |
備份 ID。 |
61******* |
| DBClusterId |
string |
叢集 ID。 |
pc-**************** |
| BackupsLevel |
string |
備份組層級，取值範圍如下：
|
Level-1 |
| BackupMode |
string |
備份模式，取值範圍如下：
|
Automated |
| BackupMethod |
string |
資料備份方法，僅支援快照備份，取值固定為 Snapshot 。 |
Snapshot |
| TotalLevel2BackupSize |
string |
指定地區的二級備份總大小，單位為 Byte。 說明
|
4639948800 |
樣本
正常返回樣本
JSON格式
{
"TotalRecordCount": "1",
"PageRecordCount": "1",
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"PageNumber": "1",
"Items": {
"Backup": [
{
"BackupSetSize": "4639948800",
"ConsistentTime": "1605425407",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-11-15T07:30:05Z",
"ExpectExpireTime": "2022-10-24T08:13:23Z",
"ExpectExpireType": "EXPIRED\u0000\u0000",
"IsAvail": "0",
"BackupEndTime": "2020-11-15T07:30:20Z",
"BackupId": "61*******",
"DBClusterId": "pc-****************",
"BackupsLevel": "Level-1",
"BackupMode": "Automated",
"BackupMethod": "Snapshot"
}
]
},
"TotalLevel2BackupSize": "4639948800"
}錯誤碼
|
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.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。