Updated on 2026-02-12 GMT+08:00

Creating an Asynchronous Sharing Task

Function

Create an asynchronous sharing task.

URI

POST /koodrive/ose/v1/share/tasks

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

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

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. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

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

Range:

N/A

Default Value:

N/A

X-Hw-Agentname

Yes

String

Definition:

Carrier name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

taskType

Yes

Integer

Definition:

Batch operation task type.

Constraints:

N/A

Range:

  • 1: package download

  • 2: dump

Default Value:

N/A

containerId

Yes

String

Definition:

Space where the file is located.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

fileIds

Yes

Array of strings

Definition:

File ID list.

Constraints:

The number of file IDs ranges from 1 to 1000.

Range:

N/A

Default Value:

N/A

targetFileId

No

FileIdInfo object

Definition:

Target directory information. If the target directory is the root directory, the value of fileId must be root.

Constraints:

This field is mandatory when taskType is set to 2.

Range:

N/A

Default Value:

N/A

zipName

No

String

Definition:

Compressed package name.

Constraints:

This field is mandatory when taskType is set to 1.

Range:

N/A

Default Value:

N/A

shareId

Yes

String

Definition:

Sharing ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

kdstoken

No

String

Definition:

Temporary token for sharing.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 3 FileIdInfo

Parameter

Mandatory

Type

Description

fileId

Yes

String

Definition:

File ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

containerId

Yes

String

Definition:

Space ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

Integer

Response code.

msg

String

Response information.

taskId

String

Task ID.

Example Requests

POST /koodrive/ose/v1/share/tasks

{
  "taskType" : 2,
  "containerId" : "IAABh_RdhS8bOg0cA1684711052660690818",
  "fileIds" : [ "Fk63FCWhcDAga2puvYKRG1oTMjs-m30sI" ],
  "shareId" : "1689765568237837824",
  "kdstoken" : "aea2968ec8cfac338cd4647f071c44644c491d0a2039cd6c",
  "targetFileId" : {
    "fileId" : "FhTB_fxx3LRszaivDFX9NN5JRNLnS9Gob",
    "containerId" : "IAABh_RdhS8bOg0cA1684711052660690818"
  }
}

Example Responses

Status code: 200

OK

{
  "code" : 0,
  "msg" : "Success",
  "taskId" : "1689765568237837824"
}

Status Codes

Status Code

Description

200

OK