Updated on 2024-07-30 GMT+08:00

Downloading a File

Function

Download a file.

URI

POST /koodrive/ose/v1/share/download

Request Parameters

Table 1 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

Service trace ID, which contains 58 bits.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

shareId

Yes

String

Sharing ID.

fileId

Yes

String

File ID.

kdstoken

Yes

String

Temporary token for sharing.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

downloadUrl

String

Download link.

Example Requests

POST /koodrive/ose/v1/share/download

{
  "shareId" : "string",
  "fileId" : "string",
  "kdstoken" : "string"
}

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "downloadUrl" : "string"
}

Status Codes

Status Code

Description

200

OK