更新时间:2024-10-24 GMT+08:00
分享

查询批量操作任务列表

功能介绍

查询批量操作任务列表。

URI

GET /koodrive/ose/v1/jobs

表1 Query参数

参数

是否必选

参数类型

描述

type

Integer

任务类型,枚举值:

  • 1:批量复制任务

  • 2:批量删除任务

  • 3:批量移动任务

  • 4:批量还原回收站

  • 5:云解压

  • 6:打包下载

status

Integer

任务状态

  • 0:待处理

  • 1:处理中

  • 2:已完成

  • 3:已取消

offset

Integer

偏移量,最小值为0

limit

Integer

最大返回个数。最小值为1,最大值为100

请求参数

表2 请求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表示美式英语,不传默认美式英语

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应消息

data

Array of JobInfo objects

批量任务列表信息

表4 JobInfo

参数

参数类型

描述

taskId

String

任务标识

taskType

Integer

任务类型

actionType

Integer

操作类型

status

Integer

任务状态

  • 0:待处理

  • 1:处理中

  • 2:已完成

  • 3:已取消

taskResultCode

Integer

任务处理结果

  • 1:全部成功

  • 2:部分失败

  • 3:全部失败

resultCode

Integer

任务处理结果码

contentNum

Integer

请求文件数量

containerId

String

目标空间ID,跨空间场景时取目标空间ID

tenantId

String

租户标识

beginTime

String

任务开始时间

endTime

String

任务结束时间

createTime

String

任务创建时间

状态码: 400

表5 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应描述

请求示例

查询批量操作任务列表请求示例。

GET /koodrive/ose/v1/jobs?offset=0&limit=2

Authorization:Bearer+10f88*************5a544791e9ff

响应示例

状态码: 200

返回查询到的任务列表

{
  "data" : [ {
    "taskId" : "1320279189273965056",
    "taskType" : 2,
    "actionType" : 201,
    "status" : 2,
    "taskResultCode" : 1,
    "contentNum" : 1,
    "containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236",
    "beginTime" : "20231227151904",
    "endTime" : "20231227151904",
    "createTime" : "20231227151904"
  }, {
    "taskId" : "1320279092268104960",
    "taskType" : 2,
    "actionType" : 201,
    "status" : 2,
    "taskResultCode" : 1,
    "contentNum" : 4,
    "containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236",
    "beginTime" : "20231227151852",
    "endTime" : "20231227151852",
    "createTime" : "20231227151852"
  } ],
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

返回查询到的任务列表

400

错误响应

401

鉴权失败

500

内部服务错误

相关文档