查看导入任务文件列表¶
列出一个导入任务的文件级处理结果,并按文件状态筛选。
GET https://api.moi.matrixorigin.cn/v5/task/files?task_id=$TASK_ID
调用前准备¶
查询参数¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $TASK_ID 替换为实际值。
curl "https://api.moi.matrixorigin.cn/v5/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"
状态代码 3 表示失败文件。重复出现 status 可选择多个状态。
curl "https://api.moi.matrixorigin.cn/v5/task/files?task_id=$TASK_ID&status=3" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
将 page 加 1,直至累计读取的文件数达到 data.total,或下一页 data.files 为空。
curl "https://api.moi.matrixorigin.cn/v5/task/files?task_id=$TASK_ID&page=2&page_size=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
导入任务 ID。 |
|
integer |
否 |
页码;省略或小于 1 时使用第 1 页。 |
|
integer |
否 |
每页条数;省略或小于 1 时使用 20。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
导入任务 ID。 |
|
integer(整数数组) |
否 |
文件状态; |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
导入任务 ID。 |
|
integer |
否 |
下一页页码。 |
|
integer |
否 |
每页条数。 |
成功响应¶
data.total 是当前状态筛选后的文件总数;data.total_sum 是该任务的全部文件数。
{
"code": "OK",
"msg": "OK",
"data": {
"files": [
{
"id": "file_01",
"name": "orders.csv",
"type": 1,
"status": 3,
"size": 1024,
"reason": "parse failed",
"path": "orders/orders.csv"
}
],
"total": 1,
"total_sum": 3,
"total_success": 2,
"total_failed": 1
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object(对象数组) |
当前页文件。 |
|
string |
文件 ID。 |
|
string |
文件名称。 |
|
integer |
文件类型代码。 |
|
integer |
文件状态代码。 |
|
integer |
文件大小,单位为字节。 |
|
string |
失败原因。 |
|
string |
来源路径。 |
|
integer |
当前筛选条件下的文件总数。 |
|
integer |
任务全部文件数。 |
|
integer |
成功文件数。 |
|
integer |
失败文件数。 |
错误响应¶
{
"code": "ErrServer",
"msg": "server error",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
将失败文件的 data.files[].id 传给重试导入失败文件。