暂停任务

暂停一个导入任务。成功响应不返回任务状态,请再查询详情确认状态。

POST https://moi.matrixorigin.cn/newmoi/task/pause

调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和任务 ID。

下方示例使用:

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

  • $WORKSPACE_ID:要暂停任务的工作区 ID,通过 X-Workspace-ID Header 传递。

  • $TASK_ID:要暂停的任务 ID。

请求体

字段

类型

是否必填

说明

task_id

string

要暂停的导入任务 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/task/pause" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{\"task_id\":\"$TASK_ID\"}"

成功响应

成功时返回 200datanull。该接口不返回暂停后的任务状态。

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

该接口不返回暂停后的任务状态。

错误响应

{
  "code": "ErrForbidden",
  "msg": "permission denied",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

请求体无效。

修正 JSON 和 task_id 后重试。

403

ErrForbidden

调用者没有操作任务的权限。

检查工作区和对象授权。

503

ErrCoreAuthorizeUnavailable

服务暂时无法完成授权检查。

稍后重试。

200

ErrServer

服务未能暂停任务。

同时检查 HTTP 状态和 code

后续操作

用同一任务 ID 查询任务详情确认已暂停。需要继续时恢复任务

最后更新于