取消批量任务 - CancelJob
功能介绍
取消一个批量任务,只有当该任务状态处于status==0(待处理),或status==1(处理中)时取消才有效。取消后,任务调度模块会忽略掉该条记录。
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/cancel
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 符合i18n规范 默认取值: en-US |
| X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Date | 是 | String | 参数解释: 日期,用于app鉴权 约束限制: 日期格式:yyyyMMDD'T'HHmmss'Z' ; 例如20251103T070140Z 取值范围: 距当前时间15分钟以内,不能晚于当前时间 默认值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| jobId | 是 | String | 参数解释: 批量任务ID 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | String | 响应业务信息 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应描述 |
请求示例
取消一个批量任务。
POST /koodrive/ose/v1/cancel
Authorization:Bearer+10f**************791e9ff
{
"jobId":"1289250105886769024"
} 响应示例
状态码:200
基础响应,只返回错误码和错误信息
{
"code" : 0,
"msg" : "成功"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 基础响应,只返回错误码和错误信息 |
| 400 | 错误响应 |
| 401 | 鉴权失败 |
| 500 | 内部服务错误 |