查詢實例備份列表
更新時間 2023-08-29 15:13:52
最近更新時間: 2023-08-29 15:13:52
分享文章
接口功能介紹
調用describeBackups接口查詢實例備份列表。
接口約束
無
URI
GET /v1/openApi/describeBackups
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | 非必填 | String | 文檔數據庫對外的實例標識 | a649077e15f349cb8b4cde6f7285a568 |
| prodInstFlag | 非必填 | String | 數據庫的標簽 規定為“實例ID 實例名稱 | a649077e15f349cb8b4cde6f7285a568 test001 |
| backupName | 非必填 | String | 備份名稱 | bak001 |
| startTime | 非必填 | String | 備份查詢開始時間 | 2022-10-10 00:00:00 |
| endTime | 非必填 | String | 備份查詢結束時間 | 2022-10-10 00:00:00 |
| pageNow | 非必填 | Integer | 當前頁 | 1 |
| pageSize | 非必填 | Integer | 頁大小 | 10 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢XXX信息成功 | |
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| pageNum | 是 | Integer | 當前頁 | 1 | |
| pageSize | 是 | Integer | 每頁數量 | 10 | |
| total | 是 | Integer | 查詢總數 | 100 | |
| list | 是 | object[] | 查詢結果主體 | list |
表list
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodOrderStatus | 是 | Integer | 訂單狀態: 0->訂單正常, 1->訂單凍結, 2->訂單注銷, 3->施工中, 4->施工失敗 | ||
| storePassword | 是 | String | 存放備份數據機器的密碼 | 123456 | |
| prodInstFlag | 是 | String | dds數據庫的標簽 規定為“實例ID 實例名稱” | a649077e15f349cb8b4cde6f7285a568 test001 | |
| prodDbEngine | 是 | String | dds數據庫產品的版本 | 4.0 | |
| description | 是 | String | 描述信息 | ||
| ymdhi | 是 | String | 廢棄字段 | 1 | |
| backupType | 是 | String | 備份類型：自動備份，手動備份 | 自動備份 | |
| result | 是 | String | 對操作結果的簡單描述 | ||
| storeUser | 是 | String | 存放備份數據的用戶名 | admin | |
| parameterGroupUsed | 是 | String | shard、單點或者副本集參數組名稱，可從參數組名稱中看出參數組版本 | ||
| host | 是 | String | 備份數據的來源機器 | 127.0.0.1 | |
| prodInstSetName | 是 | String | dds數據庫實例對應的SET名 | set_mm_1 | |
| storeIp | 是 | String | 備份文件存放的主機IP | 127.0.07 | |
| startTime | 是 | String | 備份開始時間 | 2022-10-10 00:00:00 | |
| toLsn | 是 | String | 備份返回的最新lsn，廢棄字段 | ||
| id | 是 | Integer | 備份表的主鍵id | 1 | |
| binlogEndTime | 是 | String | 廢棄字段 | ||
| errorcode | 是 | Integer | 結果:0代表沒有開始，1代表參數不對，2代表執行過程中，3代表成功，4代表被停止，5代表執行失敗 | 0 | |
| sshPort | 是 | String | 備份機器登錄端口 | 8888 | |
| prodInstName | 是 | String | 實例名稱 | test001 | |
| binlogPosition | 是 | String | 備份返回的binlog文件的位置，廢棄字段 | ||
| dbType | 是 | String | 數據庫類型，廢棄字段 | ||
| history | 是 | String | 對操作結果的詳細描述 | ||
| prodType | 是 | Integer | 實例類型0: 單實例, 1:一主一從, 2:一主兩從, 3:一主三從 | 0 | |
| datalen | 是 | String | 數據備份處理的數據量 | --- | |
| fromLsn | 是 | String | 備份開始的lsn，廢棄字段 | ||
| gtidLastChange | 是 | String | 廢棄字段 | ||
| storePath | 是 | String | 備份文件存放的主目錄 | /data/test | |
| binlogFileName | 是 | String | 備份返回的binlog文件名，廢棄字段 | ||
| backupDirName | 是 | String | 備份文件存放的子目錄，廢棄字段 | ||
| ctype | 是 | String | 任務上報類型，廢棄字段 | ||
| createTime | 是 | String | 創建或修改時間 | 2022-10-10 00:00:00 | |
| port | 是 | String | 操作返回的數據庫端口 | 8888 | |
| prodInstId | 是 | String | 實例id | a649077e15f349cb8b4cde6f7285a568 | |
| endTime | 是 | String | 備份結束時間 | 2022-10-10 00:00:00 | |
| backupName | 是 | String | 備份名稱 | bak001 |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeBackups?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode": 800,
"message": "Success",
"returnObj": {
"pageSize": 10,
"list": [
{
"prodOrderStatus": null,
"storePassword": null,
"prodInstFlag": "c46d8f547cc648a78a68270092e70f80 mongodb001",
"prodDbEngine": "4.0",
"description": null,
"ymdhi": null,
"backupType": "手動備份",
"result": null,
"storeUser": null,
"parameterGroupUsed": "Default-Mongo-4.0",
"host": null,
"prodInstSetName": "set_1098350",
"storeIp": null,
"startTime": 1658914910000,
"toLsn": null,
"id": 2,
"binlogEndTime": null,
"errorcode": 5,
"sshPort": null,
"prodInstName": "mongodb001",
"binlogPosition": null,
"dbType": null,
"history": null,
"prodType": 0,
"datalen": "---",
"fromLsn": null,
"gtidLastChange": null,
"storePath": null,
"binlogFileName": null,
"backupDirName": null,
"ctype": null,
"createTime": 1658914911000,
"port": null,
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"endTime": 1658914910000,
"backupName": "test-0727"
}
],
"pageNum": 1,
"total": 2
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
