查看导出任务状态

读取导出任务的文件处理状态汇总。

GET https://api.moi.matrixorigin.cn/v5/export/task/$TASK_ID/state

调用前准备

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

路径参数

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

curl "https://api.moi.matrixorigin.cn/v5/export/task/$TASK_ID/state" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数

类型

是否必填

说明

task_id

string

是

要读取状态的导出任务 ID。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 4,
    "pending": 0,
    "running": 0,
    "failed": 1,
    "completed": 3
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data

object

文件处理状态汇总。

data.total

integer

任务中的文件总数。

data.pending

integer

待处理文件数。与 running 均为 0 时,本次处理已结束。

data.running

integer

正在导出的文件数。

data.failed

integer

导出失败的文件数。为 0 且处理已结束时,表示所有文件成功。

data.completed

integer

已成功完成的文件数。

错误响应

{
  "code": "ErrServer",
  "msg": "未找到导出任务",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null。

后续操作

失败数大于 0 时,先查看导出任务文件列表,再按需重新运行导出任务。

最后更新于