功能描述
用于获取文件下载链接和信息。
请求
请求示例
GET /api/v1/file/{LibraryId}/{SpaceId}/{FilePath}?info&history_id={HistoryId}&content_disposition={ContentDisposition}&access_token={AccessToken}&user_id={UserId}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | String | 是 | |
SpaceId | String | 否 | |
FilePath | 完整文件路径,例如 foo/bar/file.docx | String | 是 |
HistoryId | 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 |