查询当前业务空间下的文件列表,支持按类目、文件名和文件 ID 过滤。
前提
已获取阿里云百炼 API Key(控制台 API Key 页面)并完成鉴权配置,详见 RAG API 概览与鉴权。数据导入接口与其他 RAG API 使用相同的 Base URL 与鉴权方式,路径前缀为 /api/v1/connector/dash/。
接口
POST /api/v1/connector/dash/listFile
查询当前业务空间下的文件列表,支持按类目、文件名和文件 ID 过滤。
通过
fileIds 参数批量查询时,单次最多传入 20 个文件 ID。请求体
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
categoryId | 是 | string | 类目 ID,通过 listCategory 获取。 |
fileName | 否 | string | 文件名(不含后缀),按精确匹配过滤。传入时需去掉扩展名,如文件 a.md 应传 a。 |
fileIds | 否 | array<string> | 文件 ID 列表,最多 20 个,用于批量查询指定文件。 |
nextToken | 否 | string | 分页游标,首次查询不传;翻页时传入上一页响应返回的 nextToken 值。 |
maxResult | 否 | integer | 每页返回的文件数量,默认 20。注意参数名为 maxResult(单数),传入 maxResults(复数)会被静默忽略。 |
请求示例
BASE_URL 为 https://{workspace_id}.cn-beijing.maas.aliyuncs.com({workspace_id} 为业务空间 ID),BAILIAN_API_KEY 为阿里云百炼 API Key。
响应示例
成功返回 200。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
code | string | 响应码,成功时为 Success。 |
message | string | 错误或提示信息,成功时为空字符串。 |
requestId | string | 请求唯一标识,排查问题时请提供此 ID。 |
data | object | 查询结果。子字段 fileList(array<object>,文件列表。元素为对象,字段:fileId(string,文件 ID)、fileName(string,文件名)、fileType(string,文件类型,如 pdf、md、docx)、category(string,所属类目 ID)、status(string,文件状态,如 PARSE_SUCCESS、PARSING、FAIL)、sizeBytes(integer,文件大小(字节))、parser(string,解析方式,如 DASHSCOPE_DOCMIND、DOCUMENT_PARSE_LLM)、uploadTime(string,上传时间)、parseErrorMessage(string,解析失败时的错误信息,成功时为空)、autoId(integer,自增 ID))、hasNext(boolean,是否还有下一页)、maxResult(integer,本次请求的每页条数)、totalCount(integer,符合条件的总条数)、nextToken(string,下一页游标。将该值作为下次请求的 nextToken 即可翻页)。 |
status | integer | 业务状态码。成功为 200,参数错误等失败场景为 400。注意失败时 HTTP 状态码仍为 200,需根据本字段与 code 判断结果。 |
错误码
| HTTP 状态码 | 错误码 code | 说明 |
|---|---|---|
| 400 | InvalidParameter | 请求参数无效。message 示例:Required parameter missing or invalid. |
| 401 | InvalidApiKey | 鉴权失败,API Key 无效或缺失。message 示例:Invalid API-key provided. |
status 与 code 判断结果。