# 创建通道实例

为指定 Provider 创建一个通道实例。敏感配置仅在请求中提交，成功响应不会返回明文。

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

## 调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和通道 Provider 标识。

下方示例使用：

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

## 路径参数

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

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `channel_type` | string | 是 | Provider 内的通道类型。 |
| `name` | string | 是 | 实例名称。 |
| `description` | string | 否 | 实例说明。 |
| `config` | object | 否 | 非敏感配置。 |
| `secrets` | object | 按通道类型要求 | 密钥和其他敏感配置。 |
| `visibility` | string | 否 | 可见范围。 |
| `labels` | object | 否 | 标签键值对。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "channel_type": "<CHANNEL_TYPE>",
    "name": "告警通道",
    "config": {
      "endpoint": "<ENDPOINT>"
    },
    "secrets": {
      "token": "<TOKEN>"
    }
  }'
```

## 成功响应

成功时返回 `201`。`data` 包含实例 ID、Provider、状态、凭据引用和非敏感配置；请求中的 `secrets` 不会回显。保存成功不等同于外部服务连接可用，请执行连接测试。

```json
{
  "code": 0,
  "data": {
    "id": "inst_01",
    "workspace_id": "ws_01",
    "provider": "wecom",
    "channel_type": "wecom_mail",
    "name": "告警通道",
    "status": "active",
    "credential_ref": "cred_01",
    "config": {
      "endpoint": "https://example.com/hook"
    },
    "created_at": "2026-08-18T01:00:00Z",
    "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.name` | string | 实例名称、说明和当前状态。 |
| `data.description` | string | 实例名称、说明和当前状态。 |
| `data.status` | string | 实例名称、说明和当前状态。 |
| `data.credential_ref` | string | 已保存凭据的引用，不是明文密钥。 |
| `data.callback_path` | string | 可用时返回的回调路径、能力和关联工具。 |
| `data.capabilities` | string（字符串数组） | 可用时返回的回调路径、能力和关联工具。 |
| `data.tool_ids` | string（字符串数组） | 可用时返回的回调路径、能力和关联工具。 |
| `data.config` | object | 非敏感配置和标签。 |
| `data.labels` | object | 非敏感配置和标签。 |
| `data.created_at` | string | 创建和最近更新时间，使用 RFC 3339 格式。 |
| `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`）
  - Provider、通道类型、配置、密钥或可见范围无效。
  - 使用该 Provider 支持的通道类型，并补齐相应的 `config` 和 `secrets`。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有创建通道实例的权限。
  - 检查工作区授权。
* - `409`
  - `4`（`ALREADY_EXISTS`）
  - 同一 Provider 下的实例定义冲突。
  - 检查已有实例或更换实例配置。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 通道实例服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

[测试已创建的通道实例](test-channel-instance.md)以检查连接。