查询通道实例详情

读取一个通道实例的非敏感配置、能力和最近测试信息。

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

调用前准备

先查询通道实例列表取得实例 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 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。

请求示例

curl "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"

成功响应

成功时返回 200。接口不会返回 secrets 的明文内容。

{
  "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"
    },
    "last_test_status": "passed",
    "last_tested_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.credential_ref	string	名称、说明和凭据引用。
data.config	object	非敏感配置和标签。
data.labels	object	非敏感配置和标签。
data.callback_path	string	回调路径、能力和关联工具；可用时返回。
data.capabilities	string（字符串数组）	回调路径、能力和关联工具；可用时返回。
data.tool_ids	string（字符串数组）	回调路径、能力和关联工具；可用时返回。
data.last_test_status	string	最近测试状态、时间和错误；尚未测试时可能不返回。
data.last_tested_at	string	最近测试状态、时间和错误；尚未测试时可能不返回。
data.last_test_error	string	最近测试状态、时间和错误；尚未测试时可能不返回。

错误响应

{
  "code": 3,
  "message": "channel instance not found"
}

常见 HTTP 错误

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

后续操作

可更新通道实例或测试已创建的通道实例。

最后更新于 2026 年 8 月 22 日