Listing Tasks

Updated on 2025-03-14 GMT+08:00

View PDF

Function

List tasks.

URI

GET /koodrive/ose/v1/task/list

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
taskType	No	Integer	Task type. 0: transfer task.
status	No	Array of integers	Task status. 0: NEW; 1: EXECUTING; 2: SUCCESS; 3: FAILED.
pageSize	No	Integer	Number of records to be returned on each page. Default and maximum value: 100. It is possible that partial or empty result pages are returned before the end of the result list has been reached.
pageCursor	No	Long	Current page cursor, which is obtained from nextCursor of the previous response.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	No	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
X-Traceid	No	String	Message log tracing ID (58 bits).
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	Yes	String	Address, which is used for app authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
taskList	Array of TaskInfo objects	Task list.
code	String	Response code.
msg	String	Response information.
nextCursor	String	Pagination cursor. If the cursor does not exist, the last record has been returned.

**Table 4** TaskInfo
Parameter	Type	Description
taskId	String	Task ID.
taskName	String	Task name.
taskType	Integer	Task type.
tenantId	String	Tenant ID.
userId	String	User ID.
status	Integer	Task status.
initParams	String	Extended field.
locale	String	User country.
resultCode	String	Task result.
createTime	String	Time creation time.
startTime	String	Task start time.
endTime	String	Task end time.

Example Requests

Queries the task list.

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

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

Example Responses

Status code: 200

Response for listing tasks.

{
  "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" : "Success."
}