更新任务¶
更新一个已暂停的导入任务。接口只会修改请求中提供的字段。
POST https://moi.matrixorigin.cn/newmoi/task/update
调用前准备¶
准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和任务 ID。先查询任务详情确认任务已暂停;未暂停的任务不能更新。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:要更新任务的工作区 ID,通过X-Workspace-IDHeader 传递。$TASK_ID:要更新的任务 ID。
请求体¶
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要更新的导入任务 ID。 |
|
string |
否 |
新任务名称;空字符串不会更新名称。 |
|
object |
否 |
文件导入的载入模式。提供该对象时,使用其中的字段更新载入计划。 |
|
integer |
否 |
载入周期类型: |
|
integer |
否 |
周期参数;按天时表示执行小时。 |
|
object |
否 |
文件筛选配置;提供该对象时整体替换当前文件筛选配置。 |
|
string(字符串数组) |
否 |
文件名 glob 模式。 |
|
integer |
否 |
最小文件大小,单位为字节。 |
|
integer |
否 |
最大文件大小,单位为字节。 |
|
integer |
否 |
最小创建时间,使用 Unix 时间戳。 |
|
integer |
否 |
最大创建时间,使用 Unix 时间戳。 |
|
integer(整数数组) |
否 |
文件类型筛选代码。 |
|
string |
否 |
文件路径筛选正则表达式。 |
|
string(字符串数组) |
否 |
来源文件 URI 列表;提供该字段时整体替换当前 URI 列表。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/task/update" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d '{
"task_id": "'$TASK_ID'",
"name": "import_orders_v2",
"load_mode_config": {
"load_interval_type": 4
}
}'
成功响应¶
成功时返回 200,data 为 null。
{
"code": "OK",
"msg": "OK",
"data": null
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
null |
该接口不返回更新后的任务;请重新查询详情确认。 |
错误响应¶
{
"code": "ErrForbidden",
"msg": "permission denied",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
请求体无效,或任务不处于已暂停状态。 |
修正 JSON,并先暂停任务。 |
|
|
调用者没有更新任务的权限。 |
检查工作区和对象授权。 |
|
|
服务暂时无法完成授权检查。 |
稍后重试。 |
|
|
服务未能更新任务。 |
同时检查 HTTP 状态和 |
后续操作¶
本接口不返回完整任务对象。用同一任务 ID 查询任务详情确认更新结果。