自訂通道使用樣本

更新時間:
Copy as MD

本文檔提供自訂通道配置樣本作為參考。

配置說明

HTTP 通道類型為例,具體配置說明如下:

參數

說明

Webhook 地址

接收推送的目標端地址,需要以 http:// 或 https:// 開頭。

代理(可選)

填寫發送警示資訊的代理,格式為 http://ip:port 。其中,ip 為Proxy 伺服器的 IP,port 為推送使用的連接埠。 若Proxy 伺服器的 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 會認為此次推送成功。

相關文檔