接口功能介绍
调用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 |
错误码
无
