[home] update alert webhook api doc (#402)

apache · Oct 30, 2022 · 3066b25 · 3066b25
1 parent 166b2c9
commit 3066b25
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 8 deletions.
diff --git a/home/docs/help/alert_webhook.md b/home/docs/help/alert_webhook.md
@@ -25,18 +25,35 @@ sidebar_label: 告警WebHook通知
 {
     "id":76456,
     "target":"available",
-    "monitorId":5739609486000128,
-    "monitorName":"API_poetry.apiopen.top",
+    "alertDefineId":232,
     "priority":0,
     "content":"监控紧急可用性告警: UN_CONNECTABLE",
+    "tag": {
+      "monitorId": 3543534545,
+      "monitorName":"API_poetry.didi.top"
+    },
     "status":0,
     "times":1,
-    "tenantId":10000,
     "gmtCreate":"2022-02-25T13:32:13",
     "gmtUpdate":"2022-02-25T13:32:13"
 }
 ```
 
+|     |     |
+|-----|-----|
+| id |	integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID |
+| target |	string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field |
+| alertDefineId	integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID |
+| priority |	string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 |
+| content |	string title: The actual content of the alarm notification 告警通知实际内容 |
+| status |	string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 |
+| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 |
+| firstTriggerTime |	integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) |
+| lastTriggerTime |	integer($int64) title: Alarm trigger time (timestamp in milliseconds) 最近告警触发时间(毫秒时间戳) |
+| nextEvalInterval |	integer($int64) title: Alarm evaluation interval (milliseconds) 告警评估时间间隔(单位毫秒) |
+| tags	| example: {key1:value1} |
+| gmtCreate |	string($date-time) title: Record the latest creation time (timestamp in milliseconds) 记录最新创建时间(毫秒时间戳) |
+| gmtUpdate	|string($date-time) title: 记录最新修改时间(毫秒时间戳) |
 
 ### webhook通知常见问题   
 

diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_webhook.md b/home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_webhook.md
@@ -20,23 +20,42 @@ sidebar_label: Alert webHook notification
 
 ### WebHook callback POST body BODY content   
 
-Content format：JSON   
+Content format：JSON  
 ```json
 {
     "id":76456,
     "target":"available",
-    "monitorId":5739609486000128,
-    "monitorName":"API_poetry.apiopen.top",
+    "alertDefineId":232,
     "priority":0,
-    "content":"Monitor emergency availability alarm: UN_CONNECTABLE",
+    "content":"监控紧急可用性告警: UN_CONNECTABLE",
+    "tag": {
+      "monitorId": 3543534545,
+      "monitorName":"API_poetry.didi.top"
+    },
     "status":0,
     "times":1,
-    "tenantId":10000,
     "gmtCreate":"2022-02-25T13:32:13",
     "gmtUpdate":"2022-02-25T13:32:13"
 }
 ```
 
+|     |     |
+|-----|-----|
+| id |	integer($int64) title: Alarm record entity primary key index ID  |
+| target |	string title: Alert target object: monitor availability-available metrics-app.metrics.field  |
+| alertDefineId	integer($int64) title: Alarm definition ID associated with the alarm  |
+| priority |	string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow  |
+| content |	string title: The actual content of the alarm notification |
+| status |	string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed |
+| times | integer($int32) title: Alarm threshold trigger times |
+| firstTriggerTime |	integer($int64) title: Alarm trigger time (timestamp in milliseconds) |
+| lastTriggerTime |	integer($int64) title: Alarm trigger time (timestamp in milliseconds) |
+| nextEvalInterval |	integer($int64) title: Alarm evaluation interval (milliseconds) |
+| tags	| example: {key1:value1} |
+| gmtCreate |	string($date-time) title: Record the latest creation time (timestamp in milliseconds) |
+| gmtUpdate	|   string($date-time) |
+
+
 
 ### Webhook notification common issues