查询任务状态

读取导出任务的状态汇总。

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

调用前准备

查询任务详情,确认要查看状态的导出任务。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和导出任务 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $TASK_ID:要查看状态的导出任务 ID,填写请求地址中的任务 ID 位置。

路径参数

参数

类型

是否必填

说明

task_id

string

要查询状态的导出任务 ID。

请求示例

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

成功响应

成功时返回 200data 仅提供文件处理状态的汇总计数;必须检查 pendingrunningfailed,不能将 HTTP 成功视为导出完成。

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

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.total

integer

任务中的文件总数。

data.pending

integer

待处理文件数。

data.running

integer

正在导出的文件数。

data.failed

integer

导出失败的文件数。

data.completed

integer

已成功完成的文件数。

错误响应

{
  "code": "ErrServer",
  "msg": "服务器内部错误",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

200

ErrServer

任务不存在或状态统计读取失败。

核对 task_id 后重试。

403

ErrForbidden

当前身份没有读取该任务的权限。

请求授予导出任务读取权限。

后续操作

仍有文件等待或处理中时,继续用同一任务 ID 查询本接口。等待与处理中数量都为 0 且无失败时,导出已完成。存在失败时,查询导出文件定位失败项,需要时再重新运行任务

最后更新于