使用DataWorks監控警示功能的自訂Webhook服務時，DataWorks預設通過公網推送警示資訊。您可根據Webhook服務的部署環境選擇對接方式：公網方式需將DataWorks的公網出口IP地址加入到Webhook服務的白名單中；內網方式則需為自訂Webhook指定與該服務網路連通的資源群組，由該資源群組發送警示訊息，以確保警示資訊能夠成功傳送。
使用範圍
網路設定
DataWorks 預設通過公網向 Webhook 服務推送警示資訊。您可根據 Webhook 服務的部署環境選擇公網方式或內網方式。
公網方式
DataWorks預設通過公網向您的Webhook服務推送警示資訊，無需額外配置網路。
如果您的Webhook服務未啟用白名單存取控制，則可忽略該操作步驟。
如果您的Webhook服務啟用了白名單存取控制，您需將以下的DataWorks公網IP地址添加至Webhook服務的IP白名單中。
地區名稱 | 地區ID | IP地址 |
華北2（北京） | cn-beijing | 47.93.5.9,47.93.60.157,47.94.111.106,59.110.166.34,60.205.184.153,60.205.227.157,60.205.223.44,123.56.217.46,123.57.155.168,123.57.243.71 |
華北3（張家口） | cn-zhangjiakou | 39.100.0.109,39.100.9.117,39.100.9.121 |
華東1（杭州） | cn-hangzhou | 47.96.30.97,47.97.175.135,116.62.247.242,120.27.233.168,121.40.70.19,121.199.31.66,121.199.41.143,121.199.61.16 |
華東2（上海） | cn-shanghai | 47.100.10.242,47.101.166.155,47.101.179.29,47.101.196.116,101.132.179.94,106.14.1.102,106.15.197.122,106.15.202.114 |
華南1（深圳） | cn-shenzhen | 47.107.81.9,47.112.11.104,47.112.21.108,47.112.22.239,47.112.23.85 |
馬來西亞（吉隆坡） | ap-southeast-3 | 47.254.198.127,47.254.200.185 |
日本（東京） | ap-northeast-1 | 47.74.22.81,47.74.23.43 |
韓國（首爾） | ap-northeast-2 | 47.80.13.207,47.80.10.92 |
西南1（成都） | cn-chengdu | 47.108.64.120,47.108.119.242 |
新加坡 | ap-southeast-1 | 47.74.209.97,47.74.229.187,47.74.243.124 |
印尼（雅加達） | ap-southeast-5 | 149.129.253.151,149.129.253.185 |
中國香港 | cn-hongkong | 47.52.128.224,47.244.33.205 |
德國（法蘭克福） | eu-central-1 | 47.91.89.154,47.254.153.91 |
美國（維吉尼亞） | us-east-1 | 47.89.191.99,47.90.253.133 |
美國（矽谷） | us-west-1 | 47.88.4.25,47.88.6.226 |
英國（倫敦） | eu-west-1 | 8.208.12.7,8.208.15.6 |
沙特（利雅得） | me-central-1 | 8.213.30.84,8.213.30.232 |
內網方式
如果您的Webhook服務部署在內網環境，您可在租戶警示策略中為自訂Webhook指定與該服務網路連通的資源群組，由該資源群組發送警示訊息，使警示資訊不出內網，資訊傳輸更安全。
登入DataWorks控制台，進入營運中心後，在左側導覽列單擊。
單擊租戶警示原則設定。
為自訂Webhook資源群組選擇與您的Webhook服務網路連通的資源群組（僅支援Serverless資源群組），完成配置。租戶警示策略的更多說明，請參見租戶警示原則設定。資源群組網路設定請參見：配置網路連通。
未選擇資源群組時，租戶內的自訂Webhook沿用預設的公網方式發送。配置生效後，警示資訊頁面頂部會提示當前租戶的自訂Webhook已啟用資源群組發送，您可單擊提示中的修改配置調整該設定。
訊息格式適配
DataWorks 向自訂 Webhook 服務推送的警示訊息為 JSON 格式。以下為各類警示的連通性測試報文、訊息體樣本及欄位含義說明。
連通性測試
{
"message":{
"content": "DataWorks Workbench Alarm Connectivity Test"
}
}
自訂警示
訊息體
周期執行個體狀態警示
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "webhookTest",
"remind_unit": "Task"
"occur_time": "2021-07-13 16:16:20",
"remind_type": "uncompleted",
"task_size": 1,
"node_id_list": "220167523",
"node_name_list": "nodeName",
"node_owner_list": "123123123",
"remind_founder": "jingyan20182222",
"number_of_alerts": 3,
"more_information": "http://..."
}
} 資源群組警示
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "規則名",
"remind_unit": "ScheduleResourceGroup",
"occur_time": "2021-07-13 16:16:20",
"remind_type": "resGroup use ratio",
"resource_group_name": "資源群組名",
"threshold": 99,
"duration": 30,
"remind_founder": "jingyan20182222"
}
}欄位含義
欄位 | 描述 | 樣本 |
title | 警示標題。 | DataWorks_Remind |
task_size | 任務數量。 | 1 |
remind_name | 規則名稱。 | webhookTest |
occur_time | 發生時間。 | 2021-07-13 16:16:20 |
remind_type | 觸發條件。 取值如下：
| completed |
node_id_list | 節點ID，英文逗號分割，最多5個。 | 220167523 |
node_name_list | 節點名，英文逗號分割，最多5個。 | nodeName |
node_owner_list | 責任人列表，英文逗號分割，最多5個。 | 123123 |
remind_founder | 規則建立人。 | jingyan20182222 |
remind_unit | 規則監控粒度。 取值如下：
| Task |
number_of_alerts | 第幾次警示。 | 3 |
more_information | DataWorks營運中心周期執行個體的URL。 | http://XXXX |
threshold | 資源群組監控特有，閾值。
| 99 |
duration | 資源群組監控特有。期間，單位為分鐘。 | 30 |
基準警示
訊息體
{
"message": {
"cycle_number": 1,
"occur_time": "2024-07-31 11:29:43",
"baseline_owners": "dp3base",
"baseline_name": "基準測試",
"key_instance": 10590018690,
"sla_time": "2024-07-30 17:30:00",
"buffer": -1081,
"title": "DataWorks_Baseline_Alert",
"status": "overSla"
}
}欄位含義
欄位 | 描述 | 樣本 |
cycle_number | 周期號，Apsara Infrastructure Management Framework線為 | 1 |
occur_time | 發生時間。 | 2024-07-31 11:29:43 |
baseline_owners | 基準責任人。 | dp3base |
baseline_name | 基準名。 | baseline_test |
key_instance | 當前關鍵執行個體。 | 10590018690 |
sla_time | 承諾時間。 | 2024-07-30 17:30:00 |
buffer | 基準餘量，單位為分鐘。 | -1081 |
title | 標題（類型）。 | DataWorks_Baseline_Alert |
status | 狀態。
| overSla |
事件警示
訊息體
{
"message": {
"task_name": "失敗任務名",
"event_type": "ERROR",
"task_owner_name": "dp3base",
"occur_time": "2024-07-30 23:06:06",
"event_name": "20240729-10000213793(⼩時失敗基準)(24)-[project:lwt_test_hongkong]出錯",
"title": "DataWorks_Event_Remind"
}
}
欄位含義
欄位 | 描述 | 樣本 |
task_name | 異常任務名。 | 失敗任務 |
event_type | 事件類型。
| ERROR |
task_owner_name | 任務責任人。 | dp3base |
occur_time | 發生時間。 | 2024-07-30 23:06:06 |
event_name | 事件名稱，格式：
|
|
title | 標題（類型）。 | DataWorks_Event_Remind |