手動備份實例
更新時間 2023-08-29 15:13:52
最近更新時間: 2023-08-29 15:13:52
分享文章
接口功能介紹
調用createBackup接口手動備份MongoDB實例。
接口約束
無
URI
POST /v1/openApi/createBackup
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 實例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 實例ID | f3687b55b1ce4cb1b781fb567b12ab0b | |
| backupName | 是 | String | 備份名稱 | ||
| description | 否 | String | 備份描述 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回碼 取值范圍：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 否 | String | 0代表成功 | 0，非0代表失敗 |
請求示例
請求體body
{
"prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
"backupName":"test005"
}
響應示例
{
"statusCode": 800,
"message": "手動備份MongoDB實例成功",
"returnObj": {
"code": 0
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 請求響應失敗，失敗原因見message |
錯誤碼
無
