千问办公企业旗舰版开发者文档:列出网盘目录。
认证方式见APP开发者文档 → 认证接入。
当前用户身份由 IAM 验证,Barn 执行文件归属与业务校验。不使用管理 API Key、Agent Token 或 OAuth 凭据替代,不自行设置 X-Gw 身份头。
200 返回裸 JSON 对象。
401 表示认证失败,403 表示资源权限拒绝;400/422 表示参数无效,404 表示当前用户资源不存在,409 表示冲突。依赖故障保持原错误,不伪造成功;503 为维护或依赖不可用,504 为请求超时。写操作结果未知时先查询资源状态,不盲目重复执行。
- 模块:文件
- 接口:GET
/api/openapi/app/v1/drive/directories/{path} - operationId:
app-get-directories-path
接口说明
当前用户身份由 IAM 验证,Barn 执行文件归属与业务校验。不使用管理 API Key、Agent Token 或 OAuth 凭据替代,不自行设置 X-Gw 身份头。
请求参数
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| path | path | string | 是 | 目录/复制为整个 URL 编码的绝对逻辑路径;文件/Office 为 query 路径 |
| limit | query | integer | 否 | 非负整数;默认 100,1~1000 按指定数量读取,0 或大于 1000 时按 100 处理。 |
| offset | query | integer | 否 | 非负整数,默认 0,表示跳过的记录数量。 |
| sort | query | string | 否 | file(按路径,默认)、modified(修改时间)、created(创建时间);不区分大小写。 |
| order | query | string | 否 | asc(默认)或 desc;不区分大小写。 |
| include | query | string | 否 | 省略、空值或 display_name;当前保留参数兼容,但不补充 display_name。 |
响应
200 返回裸 JSON 对象。
响应字段
| 字段 | 类型 | 必返 | 约束 | 说明 |
|---|---|---|---|---|
| children | array<object> | 是 | — | 本页目录子项;每项字段见下表。 |
| created_at | string | 是 | date-time | 创建时间,RFC 3339。 |
| display_name | string | 否 | — | 服务端提供的展示名称,可能省略。 |
| file_id | string | 是 | uuid | 当前用户网盘中的稳定文件/目录 UUID;重命名不改变,复制生成新 ID。 |
| is_directory | boolean | 是 | — | 是否为目录。 |
| metadata | object<string, string> | 是 | — | 字符串键值元数据;无元数据时为 {}。 |
| mime_type | string | 是 | — | MIME 类型;目录为 application/x-directory。 |
| moderation_state | string | 否 | — | 文件审核状态;未提供时不应推断审核已通过。 |
| modified_at | string | 是 | date-time | 最后修改时间,RFC 3339。 |
| path | string | 是 | — | 当前用户可见的绝对逻辑路径。 |
| size | integer | 是 | int64 | 大小,单位字节;目录按服务端累计大小返回。 |
| source | string | 是 | — | 服务端记录的文件来源,不由客户端据此判断权限。 |
| storage_path | string | 否 | — | 带隔离前缀的逻辑存储路径,不是 OSS 对象 key;仅部分响应提供。 |
| total | integer | 是 | int64 | 符合查询条件的总项数,不是本页数组长度。 |
响应字段.children[]
| 字段 | 类型 | 必返 | 约束 | 说明 |
|---|---|---|---|---|
| created_at | string | 是 | date-time | 创建时间,RFC 3339。 |
| display_name | string | 否 | — | 服务端提供的展示名称,可能省略。 |
| file_id | string | 是 | uuid | 当前用户网盘中的稳定文件/目录 UUID;重命名不改变,复制生成新 ID。 |
| is_directory | boolean | 是 | — | 是否为目录。 |
| metadata | object<string, string> | 是 | — | 字符串键值元数据;无元数据时为 {}。 |
| mime_type | string | 是 | — | MIME 类型;目录为 application/x-directory。 |
| moderation_state | string | 否 | — | 文件审核状态;未提供时不应推断审核已通过。 |
| modified_at | string | 是 | date-time | 最后修改时间,RFC 3339。 |
| path | string | 是 | — | 当前用户可见的绝对逻辑路径。 |
| size | integer | 是 | int64 | 大小,单位字节;目录按服务端累计大小返回。 |
| source | string | 是 | — | 服务端记录的文件来源,不由客户端据此判断权限。 |
| storage_path | string | 否 | — | 带隔离前缀的逻辑存储路径,不是 OSS 对象 key;仅部分响应提供。 |