# 测试已创建的通道实例

验证已保存通道实例的当前凭据和连接配置。

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

## 调用前准备

先[查询通道实例详情](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`。

## 路径参数

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

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances/$INSTANCE_ID/test" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。测试会使用已保存的当前凭据和配置，并更新实例的最近测试信息。

```json
{
  "code": 0,
  "data": {
    "instance": {
      "id": "inst_01",
      "workspace_id": "ws_01",
      "provider": "wecom",
      "channel_type": "wecom_mail",
      "name": "告警通道",
      "status": "active"
    },
    "ok": true,
    "status": "passed",
    "last_test_status": "passed",
    "last_tested_at": "2026-08-18T01:00:00Z"
  }
}
```

当外部连接测试未通过但测试请求被正常处理时，接口仍返回 `200`：

```json
{
  "code": 0,
  "data": {
    "instance": {
      "id": "inst_01",
      "provider": "wecom"
    },
    "ok": false,
    "status": "failed",
    "last_test_status": "failed",
    "last_test_error": "<错误信息>",
    "error_code": "<ERROR_CODE>",
    "error_stage": "<STAGE>",
    "provider_error_code": "<PROVIDER_CODE>",
    "provider_error_message": "<PROVIDER_MESSAGE>",
    "error_category": "<CATEGORY>",
    "suggestion": "<SUGGESTION>",
    "last_tested_at": "2026-08-18T01:00:00Z"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功处理测试请求时为 `0`，即使连接测试本身失败。 |
| `data.instance` | object | 被测试实例的非敏感投影。 |
| `data.ok` | boolean | 连接测试是否通过。 |
| `data.status` | string | 本次和最近一次测试状态。 |
| `data.last_test_status` | string | 本次和最近一次测试状态。 |
| `data.worker_id` | string | 可用时返回的执行方和请求标识。 |
| `data.request_id` | string | 可用时返回的执行方和请求标识。 |
| `data.last_test_error` | string | 测试失败时的错误信息。 |
| `data.error_code` | string | 服务归类的错误代码、阶段和类别。 |
| `data.error_stage` | string | 服务归类的错误代码、阶段和类别。 |
| `data.error_category` | string | 服务归类的错误代码、阶段和类别。 |
| `data.provider_error_code` | string | Provider 返回的错误信息；可用时返回。 |
| `data.provider_error_message` | string | Provider 返回的错误信息；可用时返回。 |
| `data.suggestion` | string | 可操作的修复建议；可用时返回。 |
| `data.last_tested_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、实例 ID、已保存配置或凭据不可用。
  - 检查路径；必要时更新配置或重新保存凭据。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有测试实例的权限，或凭据访问被拒绝。
  - 检查工作区和 Provider 侧权限。
* - `404`
  - `3`（`NOT_FOUND`）
  - 实例不存在或不属于路径中的 Provider。
  - 检查 Provider 和实例 ID。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 通道实例服务或测试依赖暂不可用。
  - 稍后重试。
```

## 后续操作

连接失败时[更新通道实例](update-channel-instance.md)，再重新测试。