自定义渠道

自定义渠道允许组织管理员在 Quick BI 中创建对外信息推送的渠道,业务功能如:监控告警、事件订阅等业务功能可以直接引用管理员配置的渠道实现信息对外部系统的推送。

自定义渠道的配置

  1. 在组织设置页面,按照下图指引,选择机器人渠道并新建自定义渠道。

    image
  2. 新建自定义渠道对话框,配置以下参数。

    参数

    描述

    类型

    用于配置接收信息推送的方式,支持钉钉群机器人自定义渠道

    本文选择类型自定义渠道

    名称

    输入自定义渠道名称。

    推送地址

    信息推送的地址,设置的接口地址需要支持POST请求方式。

    请求添加密钥

    验签使用,会对请求进行验签,业务方需要对收到的内容进行验签处理。

    测试并保存

    会先对接口进行一次请求,如果接口超时或者 status code 不为 2xx 则认为失败,相关的配置不会进行保存;如果没有上述问题,则相关配置将会被保存。

    说明

    每次 Quick BI 请求的最大超时时间为 10 秒

    当配置好的机器人渠道发送时连续失败超过 10 次时,该 webhooks 将会被置为「失效」状态,后续相关的业务将不会继续发送。

外部系统接收与验签方式

实际发送时,Quick BI 以 POST 的方式进行内容推送,并在请求中添加如下内容,业务方可以根据实际需要进行相关校验:

请求头:

X-TaskId,任务 ID,业务方可以使用该 ID 唯一确认一次任务请求,可以进行重复性校验(即进行重复过滤)或者在出现异常时提供给 Quick BI 业务人员进行问题定位

请求参数:

timestamp:时间戳

nonce:随机串

sign:验签信息

上述请求信息中内容主要用户 webhooks 请求的防重放以及篡改的处理,相关生成方式为:

sign = SHA256.digest(timestamp + nonce + token)

其中 token 的值就是创建时生成的「请求添加密钥」,业务接收方需要校验生成的 sign 是否与预期一致。