查看导出任务文件列表¶

列出导出任务中的文件及每个文件的处理状态。

POST https://api.moi.matrixorigin.cn/v5/export/task/files

调用前准备¶

从查看导出任务详情取得任务 ID，并准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $TASK_ID 替换为实际值。

输入示例

读取一页文件

curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
    "task_id": "$TASK_ID",
    "limit": 20,
    "offset": 0
  }
EOF

筛选并排序文件

curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
    "task_id": "$TASK_ID",
    "statuses": [3],
    "order_by": "ended_at",
    "order_direction": "asc",
    "limit": 20,
    "offset": 0
  }
EOF

读取下一页

curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
    "task_id": "$TASK_ID",
    "limit": 20,
    "offset": 20
  }
EOF

参数说明

读取一页文件

参数	类型	是否必填	说明
`task_id`	string	是	要查看文件的导出任务 ID。
`limit`	integer	否	本页返回条数；省略或小于等于 0 时为 20。
`offset`	integer	否	跳过的文件记录数。

筛选并排序文件

参数	类型	是否必填	说明
`task_id`	string	是	要查看文件的导出任务 ID。
`statuses`	array of integer	否	文件状态筛选：`0` 待处理、`1` 导出中、`2` 已完成、`3` 失败。
`order_by`	string	否	排序字段：`created_at`、`started_at`、`ended_at` 或 `status`。
`order_direction`	string	否	`asc` 时升序，其他值为降序。
`limit`	integer	否	本页返回条数。
`offset`	integer	否	跳过的文件记录数。

读取下一页

参数	类型	是否必填	说明
`task_id`	string	是	要查看文件的导出任务 ID。
`limit`	integer	否	与上一页相同。
`offset`	integer	否	上一页的 `offset` 加上本页读取条数。当 `offset` 不小于 `data.total` 时停止读取。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "files": [{
      "id": "export-file-001",
      "file_name": "summary.csv",
      "file_type": ".csv",
      "status": 3,
      "full_path": ["volume-001", "reports", "summary.csv"],
      "details": "目标连接器不可用",
      "create_time": "2026-08-28T10:00:00Z",
      "start_time": "2026-08-28T10:01:00Z",
      "end_time": "2026-08-28T10:02:00Z"
    }],
    "total": 1,
    "total_success": 0,
    "total_failure": 1,
    "total_files": 1
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.files`	array of object	导出文件记录。
`data.files.id`	string	导出记录 ID。
`data.files.file_name`	string	文件名称。
`data.files.file_type`	string	由文件名识别出的扩展名。
`data.files.status`	integer	文件处理状态。
`data.files.full_path`	array of string	源文件完整路径。
`data.files.details`	string	处理详情或失败说明。
`data.files.create_time`	string 或 null	创建时间。
`data.files.start_time`	string 或 null	开始导出时间。
`data.files.end_time`	string 或 null	结束时间。
`data.total`	integer	当前筛选条件下的文件总数。
`data.total_success`	integer	任务中已成功导出的文件总数。
`data.total_failure`	integer	任务中失败文件总数。
`data.total_files`	integer	任务中的全部文件数。

错误响应¶

响应示例

{
  "code": "ErrServer",
  "msg": "无法读取导出文件",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

将失败记录的 data.files[].id 用于重新运行导出任务，随后再次查看状态。

最后更新于 2026 年 9 月 11 日