暂停任务¶
暂停一个导入任务。成功响应不返回任务状态,请再查询详情确认状态。
POST https://moi.matrixorigin.cn/newmoi/task/pause
调用前准备¶
准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和任务 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:要暂停任务的工作区 ID,通过X-Workspace-IDHeader 传递。$TASK_ID:要暂停的任务 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\"}"
成功响应¶
成功时返回 200,data 为 null。该接口不返回暂停后的任务状态。
{
"code": "OK",
"msg": "OK",
"data": null
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
null |
该接口不返回暂停后的任务状态。 |
错误响应¶
{
"code": "ErrForbidden",
"msg": "permission denied",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
请求体无效。 |
修正 JSON 和 |
|
|
调用者没有操作任务的权限。 |
检查工作区和对象授权。 |
|
|
服务暂时无法完成授权检查。 |
稍后重试。 |
|
|
服务未能暂停任务。 |
同时检查 HTTP 状态和 |
后续操作¶
最后更新于