Listing Batch Tasks

type

No

Integer

Definition:

Job type.

Constraints:

Enumerated values:

• 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

Range:

1–7

Default Value:

N/A

status

No

Integer

Definition:

Job status.

Constraints:

Enumerated values:

• 0: to be processed

• 1: being processed

• 2: completed

• 3: canceled

Range:

0-3

Default Value:

N/A

offset

Yes

Integer

Definition:

Data query offset.

Constraints:

Larger than 0

No limit on the maximum value

Range:

The value must be greater than 0.

This parameter has no upper limit.

Default Value:

N/A

limit

Yes

Integer

Definition:

Maximum number of records to be returned.

Constraints:

N/A

Range:

1–100

Default Value:

N/A

Authorization

Yes

String

Definition:

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}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication.

Constraints:

The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z.

Range:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Default Value:

N/A

code

String

Response code.

msg

String

Response message.

data

Array of JobInfo objects

Batch task list.

taskId

String

Task ID.

taskType

Integer

Task type.

actionType

Integer

Operation type.

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.

code

String

Response code.

msg

String

Response description.

code

String

Response code.

msg

String

Response description.

code

String

Response code.

msg

String

Response description.

200

Returns the queried task list.

400

Bad Request

401

Unauthorized

500

Internal Server Error