文档首页> 云盘服务 KooDrive> API参考> API> 批量任务操作> 取消批量任务
更新时间：2024-01-05 GMT+08:00
查看PDF
分享

取消批量任务

功能介绍

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

URI

POST /koodrive/ose/v1/cancel

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取

x-trace-id

否

String

消息日志跟踪标识

X-Csrf-Token

是

String

CSRF Token

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
表2 请求Body参数

参数

是否必选

参数类型

描述

jobId

是

String

任务ID

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

data

String

操作结果

状态码： 400

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

任务跟踪的请求ID号
表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

取消一个批量任务。

POST /koodrive/ose/v1/cancel

Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff
X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
{
    "jobId":"1289250105886769024"
}

响应示例

状态码： 200

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

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

状态码

状态码

描述

200

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

400

错误响应
父主题： 批量任务操作
分享：

    相关文档

    相关产品