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

创建批量任务

功能介绍

创建一个批量任务。

URI

POST /koodrive/ose/v1/jobs

请求参数

表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参数

参数

是否必选

参数类型

描述

taskType

Integer

任务类型,枚举值:

  • 1:批量复制任务

  • 2:批量删除任务

  • 3:批量移动任务

  • 4:批量还原回收站

  • 5:云解压

  • 6:打包下载

actionType

Integer

操作类型,对taskType的细分。仅在taskType为1、2、3时使用

  • 101:复制和转存

  • 201:逻辑删除(移入回收站)

  • 202:彻底删除

  • 301:普通移动

  • 501:查看压缩包

  • 502:全部解压

  • 503:部分解压

taskInfo

CreateTaskInfoReq object

创建批量任务请求

dstContainerId

String

目标空间ID

password

String

压缩包密码

表3 CreateTaskInfoReq

参数

是否必选

参数类型

描述

fileInfo

Array of fileInfo objects

文件/目录ID

newFilePath

String

操作文件变更后的新路径

srcContainerId

String

源空间的标识

uncompressFilePaths

Array of strings

部分解压的文件在压缩包内的全路径列表

表4 fileInfo

参数

是否必选

参数类型

描述

fileId

String

文件标识

filePath

String

文件全路径,包含fileId

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

msg

String

错误信息

data

String

任务id

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 401

表7 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 500

表8 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

请求示例

批量复制文件请求示例。

POST /koodrive/ose/v1/jobs

Authorization:Bearer+10f88d07fa************44791e9ff
{
    "taskType":1 ,
    "actionType":101 ,
    "dstContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ,
    "taskInfo": {
        "srcContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
        "newFilePath": "Fm9UdqBNTAQDos6l1xPlFnIqXJg2-UdqA" ,
        "fileInfo": [
            {
                "fileId": "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3"  
            }
       
        ]
    }
}

响应示例

状态码: 200

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

{
    "data": "1309243162258308352"
    "code": 0,
    "msg": "success"
}

状态码

状态码

描述

200

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

400

错误响应

401

鉴权失败

500

内部错误