All Products
Search
Document Center

Drive and Photo Service:DownloadFile

Last Updated:Feb 26, 2024

Downloads a file.

Operation description

For information about best practices for downloading a file.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/file/download

Request parameters

ParameterTypeRequiredDescriptionExample
share_idstringNo

The share ID. If you want to manage a file by using a share link, carry the x-share-token header for authentication in the request and specify share_id. In this case, drive_id is invalid. Otherwise, use an AccessKey pair or access token for authentication and specify drive_id. You must specify one of share_id and drive_id.

7JQX1FswpQ8
drive_idstringNo

The drive ID.

1
file_idstringYes

The file ID.

9520943DC264
image_thumbnail_processstringNo

The method used to generate the thumbnail of an image. If this parameter is specified, you are redirected to the URL of the generated thumbnail.

image/resize,m_fill,h_128,w_128,limit_0
video_thumbnail_processstringNo

The method used to generate the thumbnail of a video. If this parameter is specified, you are redirected to the URL of the generated thumbnail.

video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast
office_thumbnail_processstringNo

The method used to generate the thumbnail of a document. If this parameter is specified, you are redirected to the URL of the generated thumbnail.

image/resize,w_200

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

Examples

Sample success responses

JSONformat

{}

Error codes

For a list of error codes, visit the Service error codes.