查看导入任务文件列表

列出一个导入任务的文件级处理结果,并按文件状态筛选。

GET https://api.moi.matrixorigin.cn/v5/task/files?task_id=$TASK_ID

调用前准备

准备有目标工作区访问权限的个人访问令牌目标工作区 ID 和任务 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"

参数

类型

是否必填

说明

task_id

string

导入任务 ID。

page

integer

页码;省略或小于 1 时使用第 1 页。

page_size

integer

每页条数;省略或小于 1 时使用 20。

参数

类型

是否必填

说明

task_id

string

导入任务 ID。

status

integer(整数数组)

文件状态;1 已创建、2 处理中、3 失败、4 成功。

参数

类型

是否必填

说明

task_id

string

导入任务 ID。

page

integer

下一页页码。

page_size

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
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.files

object(对象数组)

当前页文件。

data.files.id

string

文件 ID。

data.files.name

string

文件名称。

data.files.type

integer

文件类型代码。

data.files.status

integer

文件状态代码。

data.files.size

integer

文件大小,单位为字节。

data.files.reason

string

失败原因。

data.files.path

string

来源路径。

data.total

integer

当前筛选条件下的文件总数。

data.total_sum

integer

任务全部文件数。

data.total_success

integer

成功文件数。

data.total_failed

integer

失败文件数。

错误响应

{
  "code": "ErrServer",
  "msg": "server error",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

将失败文件的 data.files[].id 传给重试导入失败文件

最后更新于