文档

新建推送通道

更新时间:

本篇文档介绍如何新建推送通道。

新建推送通道

  1. 项目 > 消息 中,单击 推送通道 > 新建推送通道

    image

  2. 新建推送通道 页面中配置通道信息。

    image

    信息项

    说明

    通道名称

    自定义通道名称。

    通道类型

    获取 Webhook 地址:

    添加钉钉/飞书机器人时,安全设置 对话框中的 自定义关键词 必须为 ODC。

    image

    签名密钥

    钉钉机器人加签密钥。

    指定用户

    用户手机号。

    推送消息模版

    选择推送消息语言类型。

    消息限流设置

    设置在规定时间内推送消息次数。

    描述

    支持输入不超过 200 个字符的描述信息,该项为选填项。

  3. 如上图所示,单击 发送测试消息,测试消息发送成功后,单击 新建

    image

通道类型

ODC 支持通过钉钉/飞书/企业微信/自定义方式推送消息:

通道类型

配置项

钉钉

  • 获取钉钉机器人Webhook地址

  • 签名密钥:钉钉机器人加签密钥。

  • 指定用户:用户手机号。

  • 消息模版:支持简体中文/繁体中文/英文。

  • 消息限流设置:设置在规定时间内推送消息次数。

飞书

  • 飞书 Webhook 地址

  • 签名密钥:飞书机器人加签密钥。

  • 消息模版:支持简体中文/繁体中文/英文。

  • 消息限流设置:设置在规定时间内推送消息次数。

企业微信

  • 企业微信机器人

  • 指定用户:用户手机号。

  • 消息模版:支持简体中文/繁体中文/英文。

  • 消息限流设置:设置在规定时间内推送消息次数。

自定义

  • Webhook 地址。

  • 代理:代理服务器地址,格式为 http://ip:port。

  • 请求方法:POST/GET/PUT,默认为 POST。

  • 消息模版:支持简体中文/繁体中文/英文。

  • 消息限流设置:设置在规定时间内推送消息次数。

消息模板

ODC 支持项目成员自定义简体中文/繁体中文/英文类型消息模板。默认为 Markdown 格式的消息模板。

  • 简体中文

    ### ODC ${taskType}-${taskStatus}
     - 任务ID: ${taskId}
     - 项目: ${projectName}
     - 数据库: ${databaseName}
     - 发起人: ${creatorName}
     - 触发时间: ${triggerTime}
    
  • 繁体中文

    ### ODC ${taskType}-${taskStatus}
     - 任務ID: ${taskId}
     - 項目: ${projectName}
     - 數據庫: ${databaseName}
     - 發起人: ${creatorName}
     - 觸發時間: ${triggerTime}
    
  • 英文

    ### ODC ${taskType}-${taskStatus}
     - task ID: ${taskId}
     - project: ${projectName}
     - database: ${databaseName}
     - creator: ${creatorName}
     - trigger time: ${triggerTime}
    

    支持的标签:

    标签名称

    说明

    region

    云数据库 OceanBase region。

    taskType

    任务类型。

    taskStatus

    任务状态。

    projectId

    项目 ID。

    projectName

    项目名。

    creatorId

    发起人 ID。

    creatorName

    发起人用户名。

    taskId

    任务 ID。

    connectionId

    数据源 ID。

    databaseId

    数据库 ID。

    databaseName

    数据库名。

    clusterName

    集群名。

    tenantName

    租户名。

    environment

    数据源环境。

    triggerTime

    事件触发时间。

    message

    消息体。

    title

    消息标题。

    approverId

    审批人 ID。

    approverName

    审批人用户名。

    description

    工单描述。

    ticketUrl

    工单链接。ODC 域名获取方法如下,优先级从高到低:

    1. 元数据库 config_system_configuration 表中 odc.site.url 对应的配置项。

    2. ODC Server IP。

消息限流设置

部分推送平台存在发送消息频率限制,例如钉钉自定义机器人每分钟最多发送二十条推送,若超过此上限,机器人会被限流十分钟。此外,如果短时间内收到大量推送消息,可能会导致重要消息被淹没。

因此 ODC 提供了消息限流功能,可以配置每分钟/每小时/每天某个通道推送的上限。可以通过下述方式处理超出限流配置后的消:

  • 忽略:忽略已超出限流的消息,不再重发,此时 推送记录 界面对应消息的状态为 忽略

  • 重发:限流时间过后,将自动重发超出限流的消息,在重发之前的推送状态为 待发送

相关文档