批量获取文件或文件夹信息新版SDK
更新于 2023-06-06
接口功能介绍
在存储空间内添加的文件夹或上传的文件，可调用本接口批量获取相关信息。
获取的文件和文件夹信息主要有以下区别：
-
文件大小，文件夹不可获取该字段。
-
文件后缀，文件夹不可获取该字段。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 企业存储文件读权限 | API Explorer |
| 第三方企业应用 | 支持 | 企业存储文件读权限 | API Explorer |
| 第三方个人应用 | 暂不支持 | 企业存储文件读权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Path参数
Query参数
Body参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
dentryIds | Array of String | 是 | 文件或文件夹的ID列表，最大值30。 |
option | Object | 否 | 可选参数。 |
appIdsForAppProperties | Array of String | 否 | 指定应用ID列表，最大值20。 说明
|
withThumbnail | Boolean | 否 | 是否获取文件缩略图信息。
说明
按需获取，获取时会增加接口耗时。 |
返回参数
名称 | 类型 | 描述 |
|---|---|---|
resultItems | Array | 批量获取的文件或文件夹信息列表。 |
spaceId | String | 文件或文件夹所在空间ID。 |
dentryId | String | 文件或文件夹的ID。 |
success | Boolean | 文件或文件夹获取是否成功，true表示成功。 |
errorCode | String | 错误原因。 |
dentry | Object | 文件或文件夹的信息。 |
id | String | 文件或文件夹的ID。 |
spaceId | String | 文件或文件夹所在的空间ID。 |
parentId | String | 文件或文件夹的父目录ID，根目录ID值为0。 |
type | String | 类型。
|
name | String | 文件或文件夹名称。 |
size | Long | 文件大小，单位Byte。 |
path | String | 文件或文件夹的路径。 |
version | Long | 文件或文件夹的版本号。 |
status | String | 状态。
|
extension | String | 文件的后缀。 |
creatorId | String | 创建者unionId。 |
modifierId | String | 修改者unionId。 |
createTime | String | 创建时间，iso8601格式，例如：2022-07-29T14:55Z。 |
modifiedTime | String | 修改时间，iso8601格式，例如：2022-07-29T14:55Z。 |
properties | Object | 文件或文件夹属性信息。 |
readOnly | Boolean | 文件或文件夹是否只读。
|
appProperties | Map<String, Array> | 在特定应用上的属性。 |
Array | 属性列表。 | |
name | String | 属性名。 |
value | String | 属性值。 |
visibility | String | 属性可见性。
|
uuid | String | 标识字段。 |
partitionType | String | 存储分区。
|
storageDriver | String | 驱动类型。
|
thumbnail | Object | 缩略图信息。 |
width | Integer | 缩略图宽度，单位px。 |
height | Integer | 缩略图高度，单位px。 |
url | String | 缩略图url。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | paramError | %s | 参数错误 |
403 | permissionDenied | %s | 用户缺少获取文件(夹)信息的权限 |
404 | spaceNotExist | %s | 空间不存在 |
500 | systemError | %s | 系统错误 |
500 | unknownError | Unknown Error | 未知错误 |
503 | operationTimeout | %s | 请求超时 |
