查詢實例的備份策略
更新時間 2023-08-29 15:13:52
最近更新時間: 2023-08-29 15:13:52
分享文章
接口功能介紹
調用DescribeBackupPolicy接口查詢MongoDB實例的備份策略。
接口約束
無
URI
GET /v1/openApi/describeBackupPolicy
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文檔數據庫對外的實例標識 | a649077e15f349cb8b4cde6f7285a568 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢XXX信息成功 | |
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| sshPort | 是 | String | 機器登錄端口 | 8888 | |
| storePassword | 是 | String | 機器登錄密碼 | 123456 | |
| backupOperation | 是 | Integer | 是否開啟自動備份操作 | 1 | |
| nextbackuptime | 是 | String | 下次備份的時間 | 2022-10-10 00:00:00 | |
| backupunittime | 是 | Integer | 每兩次備份的時間間隔,以秒為單位 | 1 | |
| userId | 是 | Integer | 用戶id | 149 | |
| backupinterval | 是 | Integer | 單個周期內的總備份次數，廢棄字段 | 1 | |
| storePath | 是 | String | 備份數據存放目錄 | /data/mongodb/test | |
| autoremove | 是 | Integer | 備份文件的刪除策略，表示保留最近的多少份文件 | 1 | |
| firstbackuptime | 是 | String | 首次開始備份的時間，廢棄字段 | ||
| storeUser | 是 | String | 機器登錄用戶 | root | |
| storeIp | 是 | String | 備份數據存放的機器 | 172.27.176.109 | |
| prodInstId | 是 | String | 實例id | c46d8f547cc648a78a68270092e70f80 |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeBackupPolicy?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例的備份策略成功",
"returnObj": {
"sshPort": "22",
"storePassword": "",
"backupOperation": 0,
"nextbackuptime": 1659061641000,
"backupunittime": 43200,
"userId": 149,
"backupinterval": 0,
"storePath": "/data/apps",
"autoremove": 1,
"firstbackuptime": 1658975284000,
"storeUser": "root",
"storeIp": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
