系統支持多種消息通知模式,可及時將當前資產告警情況提供給管理員,目前支持郵箱、短信、釘釘三種通知方式,告警日志類別有:系統日志、流量控制日志、告警日志。
配置郵件通知
1.登錄API安全網關。
2.在左側導航欄選擇“通知外送 > 通知接口”,進入通知接口頁面。
3.在頁面上方選擇“通知接口配置”,開始配置郵件發送信息。
4.在彈出的對話框中配置相關信息。
| 配置項 | 說明 |
|---|---|
| SMTP服務器 | SMTP服務器的IP或者域名。 |
| SMTP服務器端口 | SMTP服務器所用端口。 |
| 發件人 | 發件人的郵箱。 |
| SMTP驗證 | 郵箱是否開啟SMTP驗證。 |
| 用戶名 | 郵箱的用戶名。 |
| 密碼 | 與郵箱用戶名對應的用戶密碼。 |
| SSL加密 | 選擇郵箱是否進行SSL加密。 |
| StartTLS加密 | 選擇郵箱是否進行StartTLS加密。 |
| 編碼 | 服務器支持的編碼方式,主要為:UTF-8、GBK。 以上SMTP服務器相關配置與服務器端設置保持一致即可。 |
5.配置完通知接口后,在“通知接口”頁面單擊“新增”開始新增通知分組。
| 配置項 | 說明 |
|---|---|
| 分組名稱 | 填寫分組名稱,只能輸入中文字符、字母、數字、“_”、“.”或“-”,長度不超過64。 |
| 分組說明 | 填寫分組描述說明。 |
| 收件人郵箱 | 填寫收件人郵箱,多個用英文逗號分隔。 |
| 消息發送周期 | 默認30分鐘發送一次,可自定義發送時間周期。 |
| 日志類型 | 系統日志、流量控制日志、告警日志。 |
| 郵件主題 | 必填,填寫推送標題,變量參考填寫說明。 |
| 郵件正文 | 必填,填寫推送內容,變量參考填寫說明。 |
6.配置完成后,即可發送通知郵件。
配置短信通知
1.登錄API安全網關。
2.在左側導航欄選擇“通知外送 > 通知接口”,進入通知接口頁面,在頁面上方選擇“短信”頁簽。
3.在頁面上方選擇“通知接口配置”,開始配置短信發送信息。
| 配置項 | 說明 |
|---|---|
| 發送方式 | 選擇短信發送方式,支持Web接口或數據庫接口。 |
| Web接口 | |
| URL | 短信網關的接入URL。 |
| 請求方法 | 請求方法,支持GET、POST、PUT請求。 |
| 請求頭 | 請求頭。可添加多個請求頭信息。 |
| 請求體 | 請求Post參數內容,如果使用Json方式,該值填寫Json內容。 可以使用 ${phone} 和 ${content} 兩個參數,分別表示手機號碼和短信內容。 例:Uid=username&key=password&Mobil=${phone}&Text=${content} |
| 數據庫接口 | |
| 數據庫類型 | 選擇數據庫的類型,支持MySQL、Oracle、PostgreSQL和SQLServer。 |
| 數據庫IP/域名( | 短信通知接口數據庫IP或域名。 |
| 端口 | 短信通知接口數據庫的端口。 |
| 用戶名/密碼 | 短信通知接口數據庫的用戶名和密碼。 |
| SQL模板 | 可以使用 ${phone} 和 ${content} 兩個參數,分別表示手機號碼和短信內容。 例:insert into MSG(count,phonenum,content,prionity) values(1,${phone},${content},1) |
5.配置完通知接口后,在“通知接口”頁面單擊“新增”開始新增通知分組。
| 配置項 | 說明 |
|---|---|
| 分組名稱 | 填寫分組名稱,只能輸入中文字符、字母、數字、“_”、“.”或“-”,長度不超過64。 |
| 分組說明 | 填寫分組描述說明。 |
| 接受人手機號碼 | 填寫收件人手機號,多個用英文逗號分隔。 |
| 消息發送周期 | 默認30分鐘發送一次,可自定義發送時間周期。 |
| 日志類型 | 系統日志、流量控制日志、告警日志。 |
| 郵件主題 | 必填,填寫推送標題,變量參考填寫說明。 |
| 郵件正文 | 必填,填寫推送內容,變量參考填寫說明。 |
6.配置完成后,即可發送短信。
配置日志外發
日志外送提供Kafka外送功能,Kafka外送模塊是 APIG 系統的通用外發功能,支持配置外發接口以及外發任務來管理通過Kafka方式外發,有固定模板供客戶選擇。通過Kafka外送發送日志的格式可以根據實際的情況進行調整。
1.登錄API安全網關。
2.在左側導航欄選擇“通知外送 > 日志外送”,進入Kafka頁簽。
3.在“外送接口”區域,單擊“新增”按鈕,開始新增Kafka外送接口。
| 配置項 | 說明 |
|---|---|
| 名稱 | 日志外送接口的名稱。必須為中文字符、字母、數字、“_”、“.”或“-”,長度不超過 64 字符。 |
| Kafka節點地址 | Kafka服務器的IP(域名)及端口號。例如:192.168.0.1:9200。 |
| Kafka主題 | 消息投放到Kafka服務器的主題。 |
| Kafka分區 | 消息投放到的Kafka服務器的分區。Kafka服務器通過主題(topic)、分區(partition)和消費組(consumergroup)三個概念靈活適應各種消息場合,通過提升硬件資源利用率提高系統吞吐量。 以上Kafka相關配置與服務器端保持一致即可。 |
| 審計日志模板 | 設置發送審計日志的模板,具體字段請依據填寫說明編輯。 |
| 操作日志模板 | 設置發送操作日志的模板,具體字段請依據填寫說明編輯。 |
| 告警日志模板 | 設置發送告警日志的模板,具體字段請依據填寫說明編輯。 |
| 流量控制日志模板 | 設置發送流量控制日志的模板,具體字段請依據填寫說明編輯。 |
4.配置完成后,選擇“外送任務”,開始新增Kafka外送任務。
| 配置項 | 說明 |
|---|---|
| 任務名稱 | 日志外送任務的名稱。必須為中文字符、字母、數字、“_”、“.”或“-”,長度不超過 64 字符。 |
| 日志類型 | 審計日志、操作日志、告警日志、流量控制日志 |
| 外送接口 | 選擇維護好的外送接口 |
| 滿足條件-協議 | 默認全部 |