产品概述
功能介绍
产品优势
应用场景
基本概念
GET /api/v1/directory/{LibraryId}/{SpaceId}/{DirPath}?page={Page}&page_size={PageSize}&order_by={OrderBy}&order_by_type={OrderByType}&filter={DirectoryFilter}&access_token={AccessToken}&user_id={UserId}
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | String | 是 | |
SpaceId | String | 是 | |
DirPath | 目录路径或相簿名，对于多级目录，使用斜杠( /)分隔，例如 foo/bar；对于根目录，该参数留空。 | String | 否 |
Marker | 用于顺序列出分页的标识，不能与 page 和 page_size 参数同时使用 | String | 否 |
Limit | 用于顺序列出分页时本地列出的项目数限制，不能与 page 和 page_size 参数同时使用 | String | 否 |
Page | 分页码，默认第一页，不能与 marker 和 limit 参数同时使用 | String | 否 |
PageSize | 分页大小，默认20，不能与 marker 和 limit 参数同时使用 | String | 否 |
OrderBy | 排序字段，按名称排序为 name，按修改时间排序为 modificationTime，按文件大小排序为 size，按创建时间排序为 creationTime，按照文件对应的本地创建时间排序为 localCreationTime，按照文件对应的本地修改时间排序为 localModificationTime | String | 否 |
OrderByType | 排序方式，升序为 asc，降序为 desc | String | 否 |
DirectoryFilter | 筛选方式，不传返回全部，onlyDir 只返回文件夹，onlyFile 只返回文件 | String | 否 |
SortType | 排序方式，不传则文件和文件夹单独排序，先返回文件夹，后返回文件。union 文件和文件夹统一排序 | String | 否 |
WithInode | 0 或 1，是否返回 inode，即文件目录 ID，默认不返回 | String | 否 |
WithFavoriteStatus | 0 或 1，是否返回收藏状态，默认不返回 | String | 否 |
AccessToken | String | 否 | |
UserId | String | 否 |
{"path": [ "foo", "bar" ],"nextMarker": 1013,"fileCount": 10,"subDirCount": 8,"totalNum":18,"localSync": {"syncId": 4,"strategy": "local_to_cloud","isSyncRootFolder": true,"syncUserId": "123"},"contents": [{"name": "sub-dir1","path":["xxx","xxx"],"type": "dir","creationTime": "2020-09-22T07:43:01.000Z","modificationTime": "2020-09-22T07:43:01.000Z","versionId":2,"localSync": {"syncId": 4,"strategy": "local_to_cloud","syncUserId": "","isSyncRootFolder": false,},"authorityList": {"canView": false,"canPreview": false,"canDownload": false,"canUpload": false,"canDelete": false,"canModify": false,"canAuthorize": false,"canShare": false}},{"name": "sub-dir2","type": "dir","creationTime": "2020-09-22T07:43:14.000Z","modificationTime": "2020-09-22T07:43:14.000Z"},{"name": "file1.jpg","type": "file","creationTime": "2020-09-22T07:44:45.000Z","modificationTime": "2020-09-22T07:44:45.000Z","contentType": "image/jpg","size": "1048576","eTag": "xxx","crc64": "xxx","authorityList": {"canView": false,"canPreview": false,"canDownload": false,"canUpload": false,"canDelete": false,"canModify": false,"canAuthorize": false,"canShare": false},"metaData": {"x-smh-meta-foo": "bar"},"previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"fileType": "powerpoint",},{"name": "file2.docx","type": "file","creationTime": "2020-09-22T07:46:08.000Z","modificationTime": "2020-09-22T07:46:08.000Z","contentType": "application/vnd.openxmlformats-officedocument.wordprocessingm","size": "1048576","eTag": "xxx","crc64": "xxx","metaData": {"x-smh-meta-foo": "bar"},"previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"fileType": "powerpoint",}],"authorityList": {"canView": false,"canPreview": false,"canDownload": false,"canUpload": false,"canDelete": false,"canModify": false,"canAuthorize": false,"canShare": false,"canPreviewSelf": false,"canDownloadSelf": false}}
响应参数 | 描述 | 类型 |
path | 返回当前请求的目录结构，如果当前请求的是根目录，则该字段为空数组 | Array |
fileCount | 当前目录中的文件数（不包含孙子级） | Int |
subDirCount | 当前目录中的子目录数（不包含孙子级） | Int |
totalNum | 当前目录中的所有文件和子目录数量（不包含孙子级） | Int |
nextMarker | 用于顺序列出分页的标识 | String/Int |
contents | 目录或相簿内的具体内容 | Array |
响应参数 | 描述 | 类型 |
name | 目录或相簿名或文件名 | String |
path | 文件具体目录 | String |
inode | 文件目录ID | String |
versionId | 版本号 | String |
type | 条目类型： dir：目录或相簿。file：文件，仅用于文件类型媒体库。image：图片，仅用于媒体类型媒体库。video：视频，仅用于媒体类型媒体库。symlink：符号链接。 | String |
creationTime | ISO 8601格式的日期与时间字符串，表示目录或相簿的创建时间或文件的上传时间，例如 2020-10-14T10:17:57.953Z | String |
modificationTime | 文件最近一次被覆盖的时间，或者目录内最近一次增删子目录或文件的时间 | String |
contentType | 媒体类型 | String |
size | 文件大小，为了避免数字精度问题 | String |
eTag | 文件 ETag | String |
isFavorite | 是否被收藏，当 WithFavoriteStatus = 1时返回 | Boolean |
crc64 | 文件的 CRC64-ECMA182 校验值 | String |
metaData | 文件元数据信息 | String |
previewByDoc | 是否可通过 WPS 预览 | Boolean |
previewByCI | 是否可通过万象预览 | Boolean |
previewAsIcon | 是否可用预览图作为 icon | Boolean |
fileType | 文件类型：Excel、PowerPoint 等 | String |
category | 文件分类，比如image、video、doc等 | String |
labels | 简易文件标签 | Array |
localCreationTime | 文件对应的本地创建时间 | String |
localModificationTime | 文件对应的本地修改时间 | String |
文档反馈