# 查询通道实例列表

按 Provider 列出当前工作区中的通道实例。

```text
GET 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 标识。 |

## 查询参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `status` | string | 否 | 按实例状态筛选。 |
| `limit` | integer | 否 | 返回数量；默认 `50`，最大 `200`。 |
| `offset` | integer | 否 | 返回列表的起始位置；负数按 `0` 处理。 |

## 请求示例

```bash
curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances?limit=20&offset=0" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。每项不会返回明文密钥。

```json
{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "inst_01",
        "workspace_id": "ws_01",
        "provider": "wecom",
        "channel_type": "wecom_mail",
        "name": "告警通道",
        "status": "active",
        "credential_ref": "cred_01"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}
```

响应字段如下。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.items` | array | 当前页的通道实例。 |
| `data.items[].id` | string | 实例 ID 和所属工作区。 |
| `data.items[].workspace_id` | string | 实例 ID 和所属工作区。 |
| `data.items[].provider` | string | Provider、通道类型和当前状态。 |
| `data.items[].channel_type` | string | Provider、通道类型和当前状态。 |
| `data.items[].status` | string | Provider、通道类型和当前状态。 |
| `data.items[].credential_ref` | string | 凭据引用，不是明文密钥。 |
| `data.items[].callback_path` | string | 回调路径、能力和关联工具；可用时返回。 |
| `data.items[].capabilities` | string（字符串数组） | 回调路径、能力和关联工具；可用时返回。 |
| `data.items[].tool_ids` | string（字符串数组） | 回调路径、能力和关联工具；可用时返回。 |
| `data.items[].last_test_status` | string | 最近测试信息；尚未测试时可能不返回。 |
| `data.items[].last_tested_at` | string | 最近测试信息；尚未测试时可能不返回。 |
| `data.items[].last_test_error` | string | 最近测试信息；尚未测试时可能不返回。 |
| `data.total` | integer | 匹配总数、本页大小和起始偏移量。 |
| `data.limit` | integer | 匹配总数、本页大小和起始偏移量。 |
| `data.offset` | integer | 匹配总数、本页大小和起始偏移量。 |

## 错误响应

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

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - Provider、状态或分页参数无效。
  - 检查路径和查询参数。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有读取通道实例的权限。
  - 检查工作区授权。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 通道实例服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

使用实例的 `id` [查询通道实例详情](get-channel-instance.md)。