功能描述
用于生成调用智能媒资托管服务的访问令牌(Access Token)。调用该接口需要用到媒体库密钥,所以必须在后端调用该接口以保证密钥安全。
接口说明
路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情。
请求
请求示例
GET /api/v1/directory/
{LibraryId}
/{SpaceId}
/{DirPath}
?info&access_token={AccessToken}
请求参数:
LibraryId:媒体库 ID,必选参数。
SpaceId:空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(
-
);如果媒体库为多租户模式,则必须指定该参数。DirPath:目录或文件路径或相簿名,对于多级目录,使用斜杠(
/
)分隔,例如 foo/bar
;可选参数,对于根目录,该参数留空。AccessToken:访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"path":["xxx","yyy"],"name": "file1.jpg","type": "file","userId": "23","creationTime": "2020-09-22T07:44:45.000Z","modificationTime": "2020-09-22T07:44:45.000Z","contentType": "image/jpg","size": "1048576","eTag": "xxx","crc64": "xxx","versionId": 23,"historySize": "2323","metaData": {"x-smh-meta-foo": "bar"},"previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"fileType": "powerpoint","localSync": {"syncId": 4,"strategy": "local_to_cloud","isSyncRootFolder": true,"syncUserId": "123"}}
响应体字段说明:
path:文件具体目录。
name:字符串,目录或相簿名或文件名。
type:字符串,条目类型:
dir
:目录或相簿。file
:文件,仅用于文件类型媒体库。image
:图片,仅用于媒体类型媒体库。video
:视频,仅用于媒体类型媒体库。symlink
:符号链接。userId:字符串,创建人 ID。
creationTime:ISO 8601格式的日期与时间字符串,表示目录或相簿的创建时间或文件的上传时间,例如
2020-10-14T10:17:57.953Z
。modificationTime:文件最近一次被覆盖的时间,或者目录内最近一次增删子目录或文件的时间。
contentType:媒体类型。
size:文件大小,为了避免数字精度问题,这里为字符串格式。
eTag:文件 ETag。
crc64:文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式。
versionId:版本号。
historySize:历史版本占用大小。
metaData:文件元数据信息。
previewByDoc:是否可通过 wps 预览。
previewByCI:是否可通过万象预览。
previewAsIcon:是否可用预览图作为 icon。
fileType:文件类型:excel、powerpoint 等。
localSync:当该文件夹是同步盘,或是同步盘的子级文件目录时,返回该字段。
isSyncRootFolder:当前文件夹是否为同步盘,如果是同步盘根目录返回 true,如果是同步盘子级节点,返回 false,如果不是同步盘,不返回该字段。
strategy:当该文件夹为同步盘时,返回同步方式,
local_to_cloud
,非必返。syncId:当该文件夹为同步盘时,返回同步任务 ID。
syncUserId:当该文件夹为同步盘时,返回设置同步任务的 userId。