获取文件下载链接和信息

最近更新时间:2025-10-24 15:25:21

我的收藏

功能描述

用于获取文件下载链接和信息。

请求

请求示例

GET /api/v1/file/{LibraryId}/{SpaceId}/{FilePath}?info&history_id={HistoryId}&content_disposition={ContentDisposition}&access_token={AccessToken}&user_id={UserId}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
SpaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
FilePath
完整文件路径,例如 foo/bar/file.docx
String
HistoryId
历史版本 ID,用于获取不同版本的文件内容,不传默认为最新版。获取请参见 查看历史版本列表
String
ContentDisposition
用于设置 Content-Disposition 响应头,支持 inline 或者 attachment,不传默认为 inline
String
Purpose
用途,可以设置为 download 或者 preview,用于决定是否将该文件加入最近使用文件列表中,如果设置为 preview,则会将该文件加入最近使用文件列表中,否则不会加入
String
AccessToken
访问令牌,获取请参见 生成访问令牌
String
UserId
用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参见 生成访问令牌接口
String
TrafficLimit
单链接下载限速,范围100KB/s-100MB/s,单位B
number
pre_check
是否只用于校验文件是否可预览和下载,设置该参数后返回结果中不包含cosUrl
String

请求体

该请求无请求体。

响应

响应码

获取成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"cosUrl": "https://xxx-1254105469.c0s.ap-guangzhou.myqcloud.com/xxx",
"cosUrlExpiration": "2021-02-02T08:21:47.000Z",
"availableCosUrls":["https://xxx-1254105469.c0s.ap-guangzhou.myqcloud.com/xxx"],
"type": "video",
"creationTime": "2021-02-01T08:21:47.000Z",
"modificationTime": "2021-02-01T08:21:47.000Z",
"contentType": "video/mp4",
"size": "60",
"eTag": "\\"b9f58108004f49103f23d3fdd6ff3876\\"",
"crc64": "33090853022223205",
"fileType":"powerpoint",
"previewByDoc": true,
"previewByCI": false,
"previewAsIcon": true,
"metaData": {
"x-smh-meta-foo": "bar"
}
"labels": ["动物", "大象", "亚洲象"],
"category": "video",
"localCreationTime": "2022-07-26T02:58:09.000Z",
"localModificationTime": "2022-07-26T02:58:09.000Z",
"versionId": 1
}
响应体字段说明:
响应参数
描述
类型
cosUrl
带签名的下载链接,签名有效时长约 2 小时,需在签名有效期内发起下载
Array
cosUrlExpiration
带签名链接到期时间
String
availableCosUrls
可获得的下载链接
String Array
type
文件类型
String
creationTime
文件首次完成上传的时间
String
modificationTime
文件最近一次被覆盖的时间
String
contentType
媒体类型
String
size
文件大小
String
eTag
文件 eTag
String
crc64
文件的 CRC64-ECMA182 校验值
String
previewByDoc
是否可通过 wps 预览
Boolean
previewByCI
是否可通过万象预览
Boolean
previewAsIcon
是否可用预览图当做 icon
Boolean
fileType
文件类型:excel、powerpoint 等
String
metaData
元数据,如果没有元数据则不存在该字段
String
labels
简易文件标签列表,通过上传、修改文件时指定的
Array
category
文件自定义的分类
String
localCreationTime
文件对应的本地创建时间
String
localModificationTime
文件对应的本地修改时间
String
versionId
文件版本号
Int

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。