取消恢复任务
更新时间 2023-10-12 15:22:34
最近更新时间: 2023-10-12 15:22:34
取消恢复任务API说明
接口介绍
取消一个恢复任务
接口约束
1、只能取消进行中的恢复任务，其他状态的任务无法取消
URI
POST /v4/backup/cancel-restore-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| backupRestoreID | 是 | String | 恢复任务ID | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码。 | 参考状态码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupRestoreID | 是 | String | 任务ID | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupRestoreID": "41f64827-0005-5987-9c86-bea5deb5d15d",
}
响应示例
{
"returnObj": {
"backupRestoreID": "41f64827-0005-5987-9c86-bea5deb5d15d"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考状态码
