Appearance
搜索文件
递归搜索工作空间中文件名包含指定关键词的文件,仅返回文件,不含目录。关键词匹配大小写不敏感。
- 接口路径:
POST /v1/openapi/app/files/search
请求头
| 参数名 | 必填 | 说明 |
|---|---|---|
| Content-Type | 是 | application/json |
| Authorization | 是 | 鉴权凭证,格式 Bearer sk_xxx |
请求参数
json
{
"user_id": "user123",
"keyword": "report",
"path": "/"
}| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user_id | string | 是 | 业务方用户 ID,用于确定所属工作空间 |
| keyword | string | 是 | 搜索关键词,匹配文件名,大小写不敏感 |
| path | string | 否 | 搜索起始目录,默认 / |
响应示例
json
{
"code": 200,
"data": {
"keyword": "report",
"total": 2,
"files": [
{
"name": "report.csv",
"path": "/data/report.csv",
"size": 10240,
"is_dir": false,
"mod_time": "2026-05-09T08:00:00Z",
"url": "https://obs.example.com/workspaces/.../data/report.csv"
},
{
"name": "monthly_report.xlsx",
"path": "/data/2026/monthly_report.xlsx",
"size": 20480,
"is_dir": false,
"mod_time": "2026-05-08T12:30:00Z",
"url": "https://obs.example.com/workspaces/.../data/2026/monthly_report.xlsx"
}
]
},
"message": "",
"trace_id": "01965de1-1920-7fe4-aa38-2e6836c46f22"
}| 字段 | 类型 | 说明 |
|---|---|---|
| keyword | string | 搜索关键词 |
| total | number | 匹配文件总数 |
| files | array | 匹配文件列表,字段结构见文件对象结构 |
TIP
搜索为递归全量扫描,文件数量较多时响应时间会相应增加。
