# 更新通道实例

部分更新一个已创建的通道实例。未提供的字段保持不变。

```text
PATCH https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/channels/{provider}/instances/{instance_id}
```

## 调用前准备

先[查询通道实例详情](get-channel-instance.md)，确认要更新的实例。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、通道 Provider 标识和实例 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递，同时作为路径中的 `workspace_id`。
- `$PROVIDER`：通道 Provider 标识，作为路径中的 `provider`。
- `$INSTANCE_ID`：要更新的通道实例 ID，作为路径中的 `instance_id`。

提供 `channel_type` 时必须与已保存的通道类型一致。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 工作区 ID。 |
| `provider` | string | 是 | 通道 Provider 标识。 |
| `instance_id` | string | 是 | 通道实例 ID。 |

## 请求体

可更新 `channel_type`、`name`、`description`、`config`、`secrets`、`visibility` 和 `labels`。

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `channel_type` | string | 否 | Provider 内的通道类型；提供时必须与已保存类型一致。 |
| `name` | string | 否 | 实例名称。 |
| `description` | string | 否 | 实例说明。 |
| `config` | object | 否 | 非敏感配置。 |
| `secrets` | object | 否 | 密钥和其他敏感配置。 |
| `visibility` | string | 否 | 可见范围。 |
| `labels` | object | 否 | 标签键值对。 |

## 请求示例

```bash
curl -X PATCH "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances/$INSTANCE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "生产告警通道"
  }'
```

## 成功响应

成功时返回 `200` 和更新后的实例。新的密钥不会在响应中回显；更新配置或密钥后，请重新执行连接测试。

```json
{
  "code": 0,
  "data": {
    "id": "inst_01",
    "workspace_id": "ws_01",
    "provider": "wecom",
    "channel_type": "wecom_mail",
    "name": "生产告警通道",
    "status": "active",
    "credential_ref": "cred_01",
    "updated_at": "2026-08-18T01:00:00Z"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.id` | string | 实例 ID 和所属工作区。 |
| `data.workspace_id` | string | 实例 ID 和所属工作区。 |
| `data.provider` | string | Provider、通道类型和当前状态。 |
| `data.channel_type` | string | Provider、通道类型和当前状态。 |
| `data.status` | string | Provider、通道类型和当前状态。 |
| `data.name` | string | 更新后的名称、说明和非敏感配置。 |
| `data.description` | string | 更新后的名称、说明和非敏感配置。 |
| `data.config` | object | 更新后的名称、说明和非敏感配置。 |
| `data.credential_ref` | string | 凭据引用，不是明文密钥。 |
| `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`）
  - 实例 ID、Provider、通道类型、配置或密钥无效。
  - 检查路径，并确保 `channel_type` 与已保存类型一致。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有更新实例的权限。
  - 检查工作区授权。
* - `404`
  - `3`（`NOT_FOUND`）
  - 实例不存在或不属于路径中的 Provider。
  - 检查 Provider 和实例 ID。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 通道实例服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

更新密钥或连接配置后，[测试已创建的通道实例](test-channel-instance.md)。