Help Center/ KooDrive/ API Reference/ API/ Batch Task Operations/ Listing Batch Tasks

Updated on 2025-10-22 GMT+08:00

View PDF

Listing Batch Tasks

Function

List batch tasks.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /koodrive/ose/v1/jobs

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
type	No	Integer	Task type. 1: batch replication. 2: batch deletion. 3: batch relocation. 4: batch restoration of recycle bin data. 5: cloud decompression. 6: package download. 7: recycle bin clearance. (This function is available only to whitelisted users.)
status	No	Integer	Task status. 0: to be processed 1: being processed 2: completed 3: canceled
offset	Yes	Integer	Offset. Minimum value: 0.
limit	Yes	Integer	Maximum number of records to be returned. Value range: 1 to 100.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	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}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
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-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
code	String	Response code.
msg	String	Response message.
data	Array of JobInfo objects	Batch task list.

**Table 4** JobInfo
Parameter	Type	Description
taskId	String	Task ID.
taskType	Integer	Task type. 1: batch replication 2: batch deletion 3: batch relocation 4: batch restoration of recycle bin data 5: cloud decompression 6: package download 7: recycle bin clearance (This function is available only to whitelisted users.)
actionType	Integer	Operation type, which is a subdivision of taskType. This parameter is used only when taskType is set to 1, 2, or 3. 101: replication and dumping 01: logical deletion (moved to the recycle bin) 202: permanent deletion 301: common relocation 501: compressed package preview 502: full decompression 503: partial decompression 701: recycle bin clearance. (This function is available only to whitelisted users.)
status	Integer	Task status. 0: to be processed 1: being processed 2: completed 3: canceled
taskResultCode	Integer	Task result. 1: all succeeded 2: partially failed 3: all failed
resultCode	Integer	Task result code.
contentNum	Integer	Number of request files.
containerId	String	Target space ID in cross-space scenarios.
tenantId	String	Tenant ID.
beginTime	String	Task start time.
endTime	String	Task end time.
createTime	String	Time creation time.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response description.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response description.

Example Requests

Request for listing batch tasks.

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

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

Example Responses

Status code: 200

Returns the queried task list.

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