查询通道实例列表

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

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/channels/{provider}/instances

调用前准备

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

请求参数

请求示例

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

参数说明

路径参数

字段	类型	必填	说明
workspace_id	string	是	工作区 ID。
provider	string	是	通道 Provider 标识。

查询参数

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

成功响应

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

响应示例

{
  "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
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 0。

基础信息

字段	类型	说明
data.limit	integer	本页请求的最大记录数。
data.offset	integer	本页第一条记录的零基偏移量。

配置与凭据

字段	类型	说明
data.items[].credential_ref	string	凭据引用，不是明文密钥。

能力与工具

字段	类型	说明
data.items[].callback_path	string	回调路径、能力和关联工具；可用时返回。
data.items[].capabilities	array of string	回调路径、能力和关联工具；可用时返回。
data.items[].tool_ids	array of string	回调路径、能力和关联工具；可用时返回。

状态信息

字段	类型	说明
data.items[].status	string	Provider、通道类型和当前状态。
data.items[].last_test_status	string	最近测试信息；尚未测试时可能不返回。
data.items[].last_test_error	string	最近测试信息；尚未测试时可能不返回。

时间、版本与分页

字段	类型	说明
data.total	integer	匹配记录总数。
data.items[].last_tested_at	string	最近测试信息；尚未测试时可能不返回。

列表数据

字段	类型	说明
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、通道类型和当前状态。

错误响应

响应示例

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

字段说明

通用字段

字段	类型	说明
code	integer	错误代码。
message	string	面向调用者的错误信息。

后续操作

使用实例的 id 查询通道实例详情。

最后更新于 2026 年 9 月 11 日