取消备份任务
更新时间 2026-04-02 15:45:44
最近更新时间: 2026-04-02 15:45:44
接口功能介绍
取消一个备份任务
接口约束
1、只能取消进行中的备份任务，其他状态的任务无法取消
URI
POST /v4/backup/cancel-task-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d | |
| backupTaskID | 是 | String | 备份任务ID | 41f64827-0005-5987-9c86-bea5deb5d15d | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。推荐使用sourceType参数，该参数后续即将下线 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-ECS |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码。 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupTaskID | String | 任务ID | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupTaskID": "41f64827-0005-5987-9c86-bea5deb5d15d",
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupTaskID": "29a50755-c12a-4b28-bbef-d34121c3dde1"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
