查詢實例備份列表v2
更新時間 2025-10-22 18:11:36
最近更新時間: 2025-10-22 18:11:36
分享文章
接口功能介紹
查詢文檔數據庫實例備份列表
接口約束
用戶通過鑒權認證
URI
GET /DDS2/v2/openApi/describeBackups
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394*** | |
| prodInstFlag | 否 | String | 數據庫的標簽 規定為“實例ID 實例名稱 | 60d420bffb394*** test001 | |
| backupName | 否 | String | 備份名稱 | bak001 | |
| startTime | 否 | String | 備份查詢開始時間 | 2022-10-10 00:00:00 時間格式為：yyyy-MM-dd HH:mm:ss | |
| endTime | 否 | String | 備份查詢結束時間 | 2022-10-10 00:00:00 時間格式為：yyyy-MM-dd HH:mm:ss | |
| pageNow | 否 | Integer | 當前頁，不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 頁大小，不傳默認為10 | 10 | |
| backupType | 否 | String | 備份類型 | 自動備份 手動備份 | |
| isCrossDomain | 否 | String | 查詢跨域備份列表 | 傳參1表示查詢跨域備份列表 | |
| isSubscribe | 否 | String | 查詢已退訂實例備份列表 | 傳參1表示查詢已退訂實例備份列表 | |
| errorCode | 否 | Byte | 查詢備份結果 | 3表示成功，5表示失敗 | |
| targetRegionId | 否 | String | 跨域備份列表篩選目標資源池 | "81f7728662dd11ec810800155d307d5b" ，傳該參數時，isCrossDomain參數需要傳參 1 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應碼 取值范圍：800為成功，900為失敗 | 800 | |
| message | String | 響應信息 | 查詢MongoDB實例的備份列表成功 | |
| returnObj | Object | 返回對象 | returnObj | |
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 | ||
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| lastPage | Integer | 最后一頁的頁碼 | 1 | |
| navigatepageNums | Object | 可用于導航的頁碼數組 | ||
| startRow | Integer | 當前頁的第一行的索引 | 1 | |
| hasNextPage | Boolean | 指示是否有下一頁數據可用 | false | |
| prePage | Integer | 前一頁的頁碼 | 0 | |
| nextPage | Integer | 下一頁的頁碼 | 0 | |
| endRow | Integer | 當前頁的最后一行的索引 | 1 | |
| pageSize | Integer | 每頁包含的數據條目數量 | 10 | |
| list | Array of Objects | 查詢結果主體 | list | |
| pageNum | Integer | 當前頁的頁碼 | 1 | |
| navigatePages | Integer | 導航頁數的數量 | 8 | |
| total | Integer | 總數據條目數量 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| firstPage | Integer | 第一頁的頁碼 | 1 | |
| size | Integer | 當前頁包含的數據條目數量 | 1 | |
| isLastPage | Boolean | 指示當前頁是否是最后一頁 | true | |
| hasPreviousPage | Boolean | 指示是否有前一頁數據可用 | false | |
| isFirstPage | Boolean | 指示當前頁是否是第一頁 | true | |
| 表 list |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| backupType | String | 備份類型：自動備份，手動備份 | 自動備份 | |
| startTime | String | 備份開始時間 | 1715409206000 | |
| errorCode | Integer | 結果:0代表沒有開始，1代表參數不對，2代表執行過程中，3代表成功，4代表被停止，5代表執行失敗 | 3 | |
| prodInstName | String | 實例名稱 | dds-342-recovernewinstance | |
| datalen | String | 數據備份處理的數據量 | 373M | |
| storageType | String | 存儲類型，對象存儲或云硬盤存儲 | 對象存儲 | |
| prodInstId | String | 實例id | *** | |
| endTime | String | 備份結束時間 | 1715409216000 | |
| backupName | String | 備份名稱 | autoBackup_20240511143326141 | |
| id | String | 備份記錄id | ||
| prodType | Byte | 實例類型：0:單機，2:副本集(三節點)，4:副本集(五節點)，6:副本集(七節點)，10:分片集群 | 2 | |
| prodDbEngine | String | 數據庫版本 | 4.0 | |
| isDelete | Integer | 標記該記錄是否被刪除，0表示未刪除，1表示刪除 | 0 |
枚舉參數
無
請求示例
請求url
/v2/openApi/describeBackups?prodInstId=a290bde98727433c966ecd52b8e66b3f
請求頭header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
無
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例的備份列表成功",
"returnObj": {
"lastPage": 0,
"navigatepageNums": null,
"startRow": 0,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 0,
"pageSize": 1,
"list": [
{
"prodInstName": "dds-342-recovernewinstance",
"errorCode": 3,
"storageType": "對象存儲",
"prodInstId": "60d420bffb394***",
"startTime": 1715409206000,
"endTime": 1715409216000,
"backupName": "autoBackup_20240511143326141",
"dataLen": "373M",
"backupType": "自動備份",
"id":260,
"prodType":2,
"prodDbEngine":"4.0",
"isDelete":0
}
],
"pageNum": 1,
"navigatePages": 0,
"total": 32,
"pages": 0,
"firstPage": 0,
"size": 0,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": false
}
}
狀態碼
請參考
錯誤碼
請參考
