更新时间:2024-07-30 GMT+08:00

取消批量任务

功能介绍

取消一个批量任务,只有当该任务状态处于status==0(待处理),或status==1(处理中)时取消才有效。取消后,任务调度模块会忽略掉该条记录。

URI

POST /koodrive/ose/v1/cancel

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token}

X-Traceid

String

消息日志跟踪标识(必须58位)

language

String

国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语

表2 请求Body参数

参数

是否必选

参数类型

描述

jobId

String

任务ID

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 400

表4 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 401

表5 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 500

表6 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

请求示例

取消一个批量任务。

POST /koodrive/ose/v1/cancel

Authorization:Bearer+10f**************791e9ff
{
    "jobId":"1289250105886769024"
}

响应示例

状态码: 200

基础响应,只返回错误码和错误信息

{
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

基础响应,只返回错误码和错误信息

400

错误响应

401

鉴权失败

500

内部服务错误