更新时间:2026-02-03 GMT+08:00

创建批量任务 - CreateJob

功能介绍

创建一个批量任务。

授权信息

当前API调用无需身份策略权限。

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

参数解释:

业务跟踪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分钟以内,不能晚于当前时间

默认值:

不涉及

x-hw-share-folder-id

String

参数解释:

共享文件夹ID。如果传入了该请求头,则说明当前的操作是在共享文件夹内。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

taskType

Integer

参数解释:

任务类型

约束限制:

枚举值

  • 1:批量复制任务

  • 2:批量删除任务

  • 3:批量移动任务

  • 4:批量还原回收站

  • 5:云解压(数据文件需要加载到新加坡节点进行处理)

  • 6:打包下载(数据文件需要加载到新加坡节点进行处理)

  • 7:清空回收站

取值范围:

1-7

默认值:

不涉及

actionType

Integer

参数解释:

操作类型,对taskType的细分。

约束限制:

枚举值

仅在taskType为1、2、3时使用

  • 101:复制和转存

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

  • 202:彻底删除

  • 301:普通移动

  • 501:查看压缩包

  • 502:全部解压

  • 503:部分解压

  • 701:清空回收站

取值范围:

不涉及

默认值:

不涉及

taskInfo

CreateTaskInfoReq object

任务信息

dstContainerId

String

参数解释:

批量任务目标的空间ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

password

String

参数解释:

压缩包密码

taskType为5时(云解压)才涉及

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

表3 CreateTaskInfoReq

参数

是否必选

参数类型

描述

fileInfo

Array of fileInfo objects

文件/目录ID(taskType为7时可以不传)

newFilePath

String

操作文件变更后的新路径(taskType为7时可以不传)

srcContainerId

String

源空间的标识

uncompressFilePaths

Array of strings

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

表4 fileInfo

参数

是否必选

参数类型

描述

fileId

String

文件标识(只有7清空回收站不填)

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

内部错误