文档首页/ 云空间服务 KooDrive/ API参考/ API/ 任务相关基础操作/ 获取任务列表
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

获取任务列表

功能介绍

获取任务列表。

URI

GET /koodrive/ose/v1/task/list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

否

String

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

language

否

String

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

X-Traceid

否

String

消息日志跟踪id(58位)
表2 请求Body参数

参数

是否必选

参数类型

描述

taskType

否

Integer

任务类型（0：移交任务）

status

否

Array of integers

任务状态（0：NEW；1：EXECUTING；2：SUCCESS；3：FAILED；）

pageSize

否

Integer

每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果

pageCursor

否

Long

当前页游标，由前一个响应的nextCursor获取

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

taskList

Array of TaskInfo objects

任务列表

code

String

响应码

msg

String

响应信息

nextCursor

String

分页游标，如果不存在，代表已返回最后一个
表4 TaskInfo

参数

参数类型

描述

taskId

String

任务id

taskName

String

任务名称

taskType

Integer

任务类型

tenantId

String

租户id

userId

String

用户id

status

Integer

任务状态

initParams

String

拓展字段

locale

String

用户所在国家

resultCode

String

任务结果

createTime

String

任务创建时间

startTime

String

任务开始时间

endTime

String

任务结束时间

请求示例

查看任务列表

GTE /koodrive/ose/v1/task/list?taskType=0&status=2&pageSize=10&pageCursor

Authorization: Bearer+dsadasd*******4ad83c8f'

响应示例

状态码： 200

获取任务列表响应

{
  "taskListDtos" : [ {
    "taskId" : "1486254586942472064",
    "taskName" : "ceshi1111",
    "taskType" : 0,
    "status" : 2,
    "createTime" : "2024-08-12T07:22:33.000Z"
  }, {
    "taskId" : "1486368980720435072",
    "taskName" : "ceshi4",
    "taskType" : 0,
    "status" : 2,
    "createTime" : "2024-08-12T11:09:50.000Z"
  } ],
  "nextCursor" : 1723549107000,
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

获取任务列表响应

相关文档