功能简介
DatabaseClaw 提供 Channel 接入能力,支持将 DatabaseClaw 实例与飞书或企业微信机器人对接。完成接入后,您的团队成员可直接在 IM 中 @ 机器人与 DatabaseClaw 实例对话,执行数据库运维操作,无需登录控制台。
DatabaseClaw 实例将自动完成身份识别与对话隔离,并以提问者的 CAM 权限执行请求,交互体验与控制台保持一致。
支持接入的 IM 类型
Channel 是 DatabaseClaw 对即时通讯(Instant Messaging,IM)通道的统一抽象。每个 Channel 对应一个 IM 平台(如飞书、企业微信)的机器人应用,并绑定至一个 DatabaseClaw 实例。
当前支持接入的 IM 类型如下表所示:
IM 类型 | 接入方式 | 所需凭证 |
飞书 | 手动配置 | App ID + App Secret |
企业微信 | 手动配置 | Bot ID + Bot Secret |
实现机制
Channel 遵循以下核心机制:
1:1 绑定:每个 Channel 固定路由至一个 DatabaseClaw 实例。同一 DatabaseClaw 实例同类型的 Channel 仅支持接入一个。
身份绑定:IM 用户首次 @ 机器人时,需完成 OAuth 授权以绑定 DatabaseClaw 账号。未完成绑定的用户消息不会被投递处理。
权限继承: DatabaseClaw 实例以绑定者的 CAM 子账号身份调用云 API,权限管控逻辑与控制台一致。
使用限制
限制项 | 说明 |
IM 类型 | 当前仅支持飞书与企业微信。 |
绑定关系 | 每个 Channel 仅可绑定一个 DatabaseClaw 实例,不支持改绑。如需变更绑定关系,请删除后重新创建。 |
实例状态 | 实例处于运行中状态。实例处于重启、已停止或已隔离状态时,Channel 不可用。 |
身份认证 | IM 用户首次使用前需完成 OAuth 授权绑定,授权有效期为 60 天,到期后需重新授权。 同一 IM 用户同一时间仅可绑定一个 DatabaseClaw 实例。对另一个 DatabaseClaw 实例完成 OAuth 授权后,原实例的绑定关系将被覆盖,原实例最迟在 2 小时内(本地缓存临时密钥过期后)停止响应该用户的消息。 |
凭证安全 | 凭证通过 KMS 信封加密存储,控制台回显时仅展示脱敏字符。 |
注意事项
接入 Channel 前,您需先在飞书开放平台或企业微信管理后台完成应用创建并获取相应凭证。未获取凭证将无法完成配置。
提交配置后,系统需将凭证同步至 Gateway,同步期间(约 30 秒)IM 消息暂时无法送达。
删除 Channel 将同步清除全部 IM 用户的身份绑定关系。重建 Channel 后,所有用户需重新完成 OAuth 授权。
前提条件
已创建 DatabaseClaw 实例,且实例处于运行中状态。
当前操作账号为该 DatabaseClaw 实例的 Owner。
您已经拥有一个对应 Channel 的账号。
操作指引
如需接入或管理 Channel,请参见以下文档:
操作 | 说明 |
在飞书开放平台创建自建应用,获取 App ID 和 App Secret,并将飞书机器人接入 DatabaseClaw 实例。 | |
在企业微信管理后台创建应用,获取 Bot ID 和 Bot Secret,并将企业微信机器人接入 DatabaseClaw 实例。 | |
查看 Channel 状态、更新凭证或删除已接入的 Channel。 |