Skip to main content

List Files

Lists files in the current business space, supporting filtering by category, file name, and file ID.

POST
/api/v1/connector/dash/listFile
cURL
curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/listFile" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cate_abc123"
  }'
{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "hasNext": false,
    "maxResult": 20,
    "totalCount": 1,
    "maxId": 338031,
    "fileList": [
      {
        "fileId": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "status": "PARSE_SUCCESS",
        "fileName": "a.md",
        "fileType": "md",
        "parser": "DASHSCOPE_DOCMIND",
        "sizeBytes": 21,
        "uploadTime": "2026-04-01 16:03:45",
        "category": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "autoId": 338031,
        "parseErrorMessage": ""
      }
    ]
  },
  "status": 200
}
When querying files in batches using the fileIds parameter, a maximum of 20 file IDs can be passed in a single request.

Authorizations

​
string
header
required

DashScope API Key，在控制台 API Key 页面 获取。

Body

application/json
​
string
required

类目 ID，通过 listCategory 获取。

​
string

文件名（不含后缀），按精确匹配过滤。传入时需去掉扩展名，如文件 a.md 应传 a。

​
string[]

文件 ID 列表，最多 20 个，用于批量查询指定文件。

Required range:items <= 20
​
string

分页游标，首次查询不传；翻页时传入上一页响应返回的 nextToken 值。

​
integer
default20

每页返回的文件数量，默认 20。注意参数名为 maxResult（单数），传入 maxResults（复数）会被静默忽略。

Response

200-application/json
​
string

响应码，成功时为 Success。

​
string

错误或提示信息，成功时为空字符串。

​
string

请求唯一标识，排查问题时请提供此 ID。

​
object
​
integer

业务状态码。成功为 200，参数错误等失败场景为 400。注意失败时 HTTP 状态码仍为 200，需根据本字段与 code 判断结果。