接口介绍
通过接口操作备份计划
接口约束
1、触发备份计划时，计划需要是运行中状态
URI
POST /v4/backup/action-backup-policy
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 |
|---|---|---|---|
| regionID | 是 | String | 资源池ID, 例：100054c0416811e9a6690242ac110002 |
| backupPolicyID | 是 | String | 备份计划ID |
| backupPolicyOp | 是 | Integer | 1 启用 ，2 停止，3 立即执行 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 操作备份计划任务下发状态 | 参考returnObj表 | |
| detail | 是 | String | 详细的错误信息。 | 参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| status | 是 | String | 操作备份计划任务是否下发成功 | 参考响应示例 | |
| msg | 是 | String | 操作备份计划任务下发描述 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID": "31f777-827f25f-595ffa3-deb5d15d",
"backupPolicyOp": 2
}
响应示例
{
"returnObj": {
"status": "success",
"msg": "backupPolicy action success"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
请参考状态码
