OMFLOW Doc
搜索文档…
事件
每當有異常狀況發生時,系統應先產生事件進行紀錄,並透過事件規則決定是否開立事故單。而異常狀況除了由Collector收集偵測以外,未受Collector監控的軟硬體也可透過 Rest API 發送產生或關閉事件,以下將介紹發送方式。

產生事件

當異常狀況出現時可呼叫此API產生事件。
  • Method:POST
  • URL:/rest/monitor/api/event/create/
  • Post body:如下
1
{
2
"security": "<安全碼>",
3
"title": "<事件標題>",
4
"content": "<事件內容>",
5
"severity": "<嚴重等級,填入1-5>",
6
"omflow_restapi": 1,
7
"source2": "<來源>"
8
}
Copied!
上述 Post body 為轉換成事件的內容依據,其中嚴重等級分為五等級,分別為 1 (Info)、 2 (Normal)、 3 (Warning)、 4 (Major)、 5 (Critical),舉例來說,若嚴重等級為 Warning 則 severity 參數填入3。另外source2為串聯同樣設備同樣事件的索引字串,在下個章節上會進一步說明。
所有 API 使用前須取得安全碼(security),取得方式請參閱取得安全碼

關閉事件

當異常狀況排除時可呼叫此API關閉事件,系統會將所有符合指定source2字串的事件一併關閉。
  • Method:POST
  • URL:/rest/monitor/api/event/close/
  • Post body:如下
1
{
2
"security": "<安全碼>",
3
"omflow_restapi": 1,
4
"source2": "<來源>"
5
}
Copied!
所有 API 使用前須取得安全碼(security),取得方式請參閱取得安全碼

系統說明

除了本網站說明事件API的使用方式外,在系統上也有說明。可前往主選單>資料收集>事件管理的「事件API」頁籤上檢視,如下圖: