文档

自定义通道使用示例

更新时间:

本文档提供自定义通道配置示例作为参考。

配置说明

HTTP 通道类型为例,具体配置说明如下:

参数

说明

Webhook 地址

接收推送的目标端地址,需要以 http:// 或 https:// 开头。

代理(可选)

填写发送告警信息的代理,格式为 http://ip:port 。其中,ip 为代理服务器的 IP,port 为推送使用的端口。 若代理服务器的 IP 为 xxx.xxx.xxx.xxx,规划使用 80 端口发送消息,则可配置为 http://xxx.xxx.xxx.xxx:80。

请求方法

根据实际情况选择,默认为 POST。

Header 模板

根据实际需求填写 HTTP 协议的 Header 模板。不同参数之间以;分割,例如:Content-Type:application/json;charset:utf-8

Body 模板

填写推送的内容模板,为空表示不使用 HTTP body。可以通过模板引用变量,变量列表请参见新建推送通道

Response 校验信息

由于不同通道的 Response 有所差异,因此为了能否准确判断消息发送是否成功,需要配置发送成功的 Response 校验信息。

  • 若输入格式为 JSON 字符串,ODC 会解析出 JSON 中的字段并与通道 Response Body 中的对应信息进行匹配,匹配成功即为发送成功。

  • 如果不确定通道的 Response,可不配置或配置为 {},ODC 会认为消息总是发送成功。

配置示例

image

以上图为例,如果事件对应的任务 ID 为 10001,ODC 会向配置中的 Webhook 发送类似下述请求,其中data字段的属性为实际生成的推送消息:

curl -XPOST -H "Context-Type:application/json" -H "charset:utf-8" -H "appkey:xxxxxx" http://xxx.xxx.xxx.xxx:80 -d '{"jsonrpc":"2.0","params":{"output":"extend"},"auth":"*******","data":"...","task_id":"10001"}'

如果收到的响应中包含"message":"success"的键值对,则 ODC 会认为此次推送成功。

相关文档