智能媒资托管获取文件下载链接和信息

功能描述 
用于获取文件下载链接和信息。
请求
请求示例
GET /api/v1/file/{LibraryId}/{SpaceId}/{FilePath}?info&history_id={HistoryId}&content_disposition={ContentDisposition}&purpose={Purpose}&preview&access_token={AccessToken}&user_id={UserId}&traffic_limit={TrafficLimit}&pre_check&content_cas={ContentCas}&internal_domain={InternalDomain}&with_short_link={WithShortLink}&period={Period}&with_favorite_status={WithFavoriteStatus}
请求参数
请求参数
描述
类型
是否必选
LibraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
SpaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则为具体 ID，获取请参见 创建租户空间﻿
String
是
FilePath
完整文件路径，例如 foo/bar/file.docx
String
是
HistoryId
历史版本 ID，用于获取不同版本的文件内容，不传默认为最新版。获取请参见 查看历史版本列表﻿
String
否
ContentDisposition
用于设置 Content-Disposition 响应头，支持 inline 或者 attachment，不传默认为 inline
String
否
Purpose
用途，可以设置为 download 或者 preview，用于决定是否将该文件加入最近使用文件列表中，如果设置为 preview，则会将该文件加入最近使用文件列表中，否则不会加入
String
否
preview
用于获取在线预览链接，默认为下载链接
String
否
AccessToken
访问令牌，对于公有读媒体库或租户空间，可不指定该参数，否则必须指定该参数，获取请参见 生成访问令牌﻿
String
否
UserId
用户身份识别，当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份，详情请参见 生成访问令牌接口﻿
String
否
TrafficLimit
单链接下载限速，范围100KB/s-100MB/s，单位 B
Number
否
pre_check
是否只用于校验文件是否可预览和下载，设置该参数后返回结果中不包含 cosUrl
String
否
ContentCas
文件内容 Cas 标识。若指定该参数且与实际文件内容 Cas 不一致，或文件已不存在，则返回 ContentCasMismatch 错误。常用于并发场景下基于 Cas 的读一致性校验
String
否
InternalDomain
0或1，是否使用内网域名生成文件访问链接，可选参数，默认不使用；当设置为1时，返回的 cosUrl 将使用内网域名，适用于同地域内网访问场景以提升访问速度
Number
否
WithShortLink
0或1，可选参数，默认为0。设置为1时，返回的 cosUrl（及 availableCosUrls 中的地址）将被替换为短链形式
Number
否
Period
整数（单位：秒），可选参数。用于指定返回的下载/预览链接（或短链）的有效期。取值范围为 [60, max_period]，其中 max_period 为2小时（7200 秒），默认为2小时
Number
否
WithFavoriteStatus
0或1，可选参数，默认为0。设置为1时，返回体中会附加 isFavorite 字段，标识该文件是否已被当前用户收藏
Number
否
请求体
该请求无请求体。
响应
响应码
获取成功，返回 HTTP 200 OK。
响应体
application/json
响应体示例：
{
    "cosUrl": "https://smhxxxxxxxxxxxx.nj.smhshare.cn/s/AbC3xZv1",
    "cosUrlExpiration": "2026-04-21T08:21:47.000Z",
    "availableCosUrls": ["xxx"],
    "type": "video",
    "creationTime": "2021-02-01T08:21:47.000Z",
    "modificationTime": "2021-02-01T08:21:47.000Z",
    "contentType": "video/mp4",
    "size": "xxx",
    "eTag": "xxx",
    "crc64": "xxx",
    "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",
    "historySize": "0",
    "versionId": 1,
    "isFavorite": false,
    "contentCas": "xxx"
}
响应体字段说明：
响应参数
描述
类型
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
文件版本号
Number
isFavorite
当前用户是否已收藏该文件。仅当请求参数 with_favorite_status = 1时返回
Boolean
contentCas
文件内容的 Cas 标识
String
historySize
该文件所有历史版本占用的总大小（单位：字节），为了避免数字精度问题，这里为字符串格式
String
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

请求参数	描述	类型	是否必选
LibraryId	媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见创建媒体库	String	是
SpaceId	空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则为具体 ID，获取请参见创建租户空间	String	是
FilePath	完整文件路径，例如 `foo/bar/file.docx`	String	是
HistoryId	历史版本 ID，用于获取不同版本的文件内容，不传默认为最新版。获取请参见查看历史版本列表	String	否
ContentDisposition	用于设置 Content-Disposition 响应头，支持 inline 或者 attachment，不传默认为 inline	String	否
Purpose	用途，可以设置为 download 或者 preview，用于决定是否将该文件加入最近使用文件列表中，如果设置为 preview，则会将该文件加入最近使用文件列表中，否则不会加入	String	否
preview	用于获取在线预览链接，默认为下载链接	String	否
AccessToken	访问令牌，对于公有读媒体库或租户空间，可不指定该参数，否则必须指定该参数，获取请参见生成访问令牌	String	否
UserId	用户身份识别，当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份，详情请参见生成访问令牌接口	String	否
TrafficLimit	单链接下载限速，范围100KB/s-100MB/s，单位 B	Number	否
pre_check	是否只用于校验文件是否可预览和下载，设置该参数后返回结果中不包含 cosUrl	String	否
ContentCas	文件内容 Cas 标识。若指定该参数且与实际文件内容 Cas 不一致，或文件已不存在，则返回 ContentCasMismatch 错误。常用于并发场景下基于 Cas 的读一致性校验	String	否
InternalDomain	0或1，是否使用内网域名生成文件访问链接，可选参数，默认不使用；当设置为1时，返回的 cosUrl 将使用内网域名，适用于同地域内网访问场景以提升访问速度	Number	否
WithShortLink	0或1，可选参数，默认为0。设置为1时，返回的 cosUrl（及 availableCosUrls 中的地址）将被替换为短链形式	Number	否
Period	整数（单位：秒），可选参数。用于指定返回的下载/预览链接（或短链）的有效期。取值范围为 [60, max_period]，其中 max_period 为2小时（7200 秒），默认为2小时	Number	否
WithFavoriteStatus	0或1，可选参数，默认为0。设置为1时，返回体中会附加 isFavorite 字段，标识该文件是否已被当前用户收藏	Number	否

响应参数	描述	类型
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	文件版本号	Number
isFavorite	当前用户是否已收藏该文件。仅当请求参数 with_favorite_status = 1时返回	Boolean
contentCas	文件内容的 Cas 标识	String
historySize	该文件所有历史版本占用的总大小（单位：字节），为了避免数字精度问题，这里为字符串格式	String

获取文件下载链接和信息

本页目录：

功能描述

请求

请求示例

请求参数

请求体

响应

响应码

响应体

错误码