查询任务文件¶
列出一个导入任务中的文件及处理结果。根据文件状态和失败原因,决定是否重试失败文件。
GET https://moi.matrixorigin.cn/newmoi/task/files?task_id=$TASK_ID
调用前准备¶
准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和任务 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:要查询任务的工作区 ID,通过X-Workspace-IDHeader 传递。$TASK_ID:导入任务 ID。
查询参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要查询的导入任务 ID。 |
|
integer |
否 |
页码。默认值为 |
|
integer |
否 |
每页条数。默认值为 |
|
integer(整数数组) |
否 |
按文件处理状态筛选;可重复传入。状态代码: |
请求示例¶
curl "https://moi.matrixorigin.cn/newmoi/task/files?task_id=$TASK_ID&page=1&page_size=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
本文中,字段路径中的 [] 表示数组中的每一项。例如,data.files[].id 表示 data.files 数组中每一项的 id 字段。
成功时返回 200。
{
"code": "OK",
"msg": "OK",
"data": {
"files": [
{
"id": "file_01",
"name": "orders.csv",
"type": 1,
"status": 2,
"size": 1024,
"update_time": 1735632000,
"reason": "",
"user": "reader",
"start_time": 1735632000,
"end_time": 1735632060,
"path": "/orders.csv"
}
],
"total": 1,
"total_sum": 1,
"total_success": 1,
"total_failed": 0
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object(对象数组) |
当前页任务文件。 |
|
string |
文件 ID。 |
|
string |
文件名。 |
|
integer |
文件类型代码。 |
|
integer |
处理状态代码。 |
|
integer |
文件大小,单位为字节。 |
|
string |
文件的附加元数据;没有附加元数据时为空字符串。 |
|
string |
失败原因。 |
|
string |
文件关联的用户标识。 |
|
string |
文件路径。 |
|
integer |
开始处理时间的 Unix 时间戳。 |
|
integer |
结束处理时间的 Unix 时间戳。 |
|
integer |
最后更新时间的 Unix 时间戳。 |
|
integer |
当前查询返回的文件数。 |
|
integer |
全部文件总数。 |
|
integer |
成功文件总数。 |
|
integer |
失败文件总数。 |
错误响应¶
{
"code": "ErrServer",
"msg": "server error",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
查询参数无效。 |
修正 |
|
|
服务未能查询任务文件。 |
同时检查 HTTP 状态和 |
后续操作¶
仅将失败文件的 id 传给重试失败文件。