Appearance
递归列出文件树
递归列出指定目录下的完整文件树结构(不分页),支持设置最大递归深度。
- 接口路径:
POST /v1/openapi/app/files/tree
请求头
| 参数名 | 必填 | 说明 |
|---|---|---|
| Content-Type | 是 | application/json |
| Authorization | 是 | 鉴权凭证,格式 Bearer sk_xxx |
请求参数
json
{
"user_id": "user123",
"path": "/data",
"max_depth": 3
}| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user_id | string | 是 | 业务方用户 ID,用于确定所属工作空间 |
| path | string | 否 | 目录路径,默认 / |
| max_depth | int | 否 | 最大递归深度,0 表示不限制 |
响应示例
json
{
"code": 200,
"data": {
"path": "/data",
"total": 5,
"files": [
{
"name": "file.csv",
"path": "/data/file.csv",
"size": 1024,
"is_dir": false,
"mod_time": "2026-04-27T10:30:00Z",
"url": "https://obs.example.com/workspaces/.../data/file.csv"
},
{
"name": "subdir",
"path": "/data/subdir",
"size": 0,
"is_dir": true,
"mod_time": "2026-04-27T09:00:00Z"
},
{
"name": "nested.csv",
"path": "/data/subdir/nested.csv",
"size": 2048,
"is_dir": false,
"mod_time": "2026-04-26T15:00:00Z",
"url": "https://obs.example.com/workspaces/.../data/subdir/nested.csv"
},
...
]
},
"message": "",
"trace_id": "abc123"
}| 字段 | 类型 | 说明 |
|---|---|---|
| path | string | 当前目录路径 |
| total | number | 文件和目录总数 |
| files | array | 递归展开的文件树列表,字段结构见文件对象结构 |
TIP
与列出目录接口不同,此接口会递归遍历所有子目录,返回完整的文件树。文件数量较多时响应时间会相应增加,建议通过 max_depth 控制递归深度。
