# 更新自动化任务

部分更新自动化任务的配置。未提供的字段保持不变。

```text
PATCH https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/agent-automation-tasks/{automation_task_id}
```

## 调用前准备

先[查询自动化任务详情](get-task.md)确认任务当前配置，取得任务 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递，同时作为路径中的 `workspace_id`。
- `$TASK_ID`：要更新的自动化任务 ID，作为路径中的 `automation_task_id`。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 工作区 ID。 |
| `automation_task_id` | string | 是 | 自动化任务 ID。 |

## 请求体

请求体必须为 JSON 对象。所有字段均可选；未提供的字段保持不变。

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `name` | string | 否 | 任务名称和说明。 |
| `description` | string | 否 | 任务名称和说明。 |
| `agent_workspace_id` | string | 否 | 智能体所属工作区和智能体 ID。智能体工作区只能为当前工作区或系统工作区。 |
| `agent_id` | string | 否 | 智能体所属工作区和智能体 ID。智能体工作区只能为当前工作区或系统工作区。 |
| `model` | string | 否 | 模型名称和 LLM 后端 ID。 |
| `llm_backend_id` | integer | 否 | 模型名称和 LLM 后端 ID。 |
| `instruction_text` | string | 否 | 每次运行使用的固定指令。 |
| `trigger` | object | 否 | 触发配置。 |
| `auth_policy` | object | 否 | 认证策略以及工具、运行和审批策略引用。 |
| `tool_policy_ref` | string | 否 | 认证策略以及工具、运行和审批策略引用。 |
| `runtime_policy_ref` | string | 否 | 认证策略以及工具、运行和审批策略引用。 |
| `approval_policy_ref` | string | 否 | 认证策略以及工具、运行和审批策略引用。 |
| `output_contract` | object | 否 | 结构化输出约束。 |
| `status` | string | 否 | 任务状态。 |
| `labels` | object | 否 | 标签和注解键值对。 |
| `annotations` | object | 否 | 标签和注解键值对。 |
| `workflow_app_id` | string | 否 | 工作流相关引用。 |
| `agent_task_template_id` | string | 否 | 工作流相关引用。 |
| `agent_workflow_binding_id` | string | 否 | 工作流相关引用。 |
| `next_trigger_at` | string | 否 | 下次触发时间，使用 RFC 3339 格式。 |
| `api_summary` | object | 否 | API 摘要。 |

将 `status` 设置为 `active` 可启用任务；设置为 `disabled` 可停止后续触发。触发配置或认证策略变更是否有效取决于两者是否相容。

## 请求示例

```bash
curl -X PATCH "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/agent-automation-tasks/$TASK_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "disabled"
  }'
```

## 成功响应

成功时返回 `200`。更新任务配置不会改写已有运行记录使用的配置快照。

```json
{
  "code": 0,
  "data": {
    "id": "task_01",
    "workspace_id": "ws_01",
    "status": "disabled",
    "version": 2,
    "updated_at": "2026-08-18T02:00:00Z"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.id` | string | 任务 ID 和所属工作区 ID。 |
| `data.workspace_id` | string | 任务 ID 和所属工作区 ID。 |
| `data.status` | string | 更新后的状态和任务版本。 |
| `data.version` | integer | 更新后的状态和任务版本。 |
| `data.trigger` | object | 更新后的触发、认证和输出配置；未设置时不返回。 |
| `data.auth_policy` | object | 更新后的触发、认证和输出配置；未设置时不返回。 |
| `data.output_contract` | object | 更新后的触发、认证和输出配置；未设置时不返回。 |
| `data.execution` | object | 更新后的任务执行计划。 |
| `data.updated_at` | string | 最近更新时间，使用 RFC 3339 格式。 |

## 错误响应

```json
{
  "code": 2,
  "message": "<错误信息>"
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 请求体、工作区范围、触发配置、认证策略或状态字段无效。
  - 检查 JSON 和触发方式对应的配置。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有经过工作区访问和有效角色校验。
  - 使用具有工作区访问权限的身份和有效角色。
* - `404`
  - `3`（`NOT_FOUND`）
  - 任务或更新后的目标智能体不存在。
  - 检查任务和智能体标识。
* - `409`
  - `4`（`ALREADY_EXISTS`）
  - 更新与任务当前状态或并发版本发生冲突。
  - 刷新任务详情后，基于当前版本重新提交更新。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 执行计划、工作流或任务服务暂不可用。
  - 稍后重试。
```

## 后续操作

用同一任务 ID [查询自动化任务详情](get-task.md)确认当前配置和状态。