DataWorks的OpenEvent旨在將DataWorks的各類狀態變更情況以訊息的方式觸達到使用者,便於使用者訂閱訊息並做出個人化的響應。例如,您可以通過OpenEvent訂閱表變更,從而實現核心表的即時監控;通過OpenEvent訂閱任務變更,實現定製化開發即時任務大屏的資料監控。本文為您介紹OpenEvent支援訂閱的事件類型與配置流程。
功能介紹
DataWorks已開放DataWorks側核心流程的狀態變更訊息,並支援將訊息推送至OpenEvent服務,您可通過DataWorks的OpenEvent模組對空間訊息進行推送管理,並結合事件匯流排EventBridge服務實現DataWorks事件訊息的過濾與消費管理。
DataWorks的OpenEvent具備以下優勢:
-
節省營運成本:通過開啟DataWorks開放平台的訊息訂閱功能,您可以很方便地訂閱事件訊息。
-
提升開發效能:通過在DataWorks介面上建立相關配置,您無需再進行發送訊息相關配置,僅需做好相關SDK開發的準備配置工作及訂閱訊息配置,節省繁雜的手工操作。
-
實現個人化需求:DataWorks提供豐富的事件類型,您可以通過訂閱不同事件類型的訊息,快速感知業務狀態變化資訊,及時做好個人化響應和決策。
適用範圍
-
版本限制:僅支援DataWorks企業版。
-
地區限制:僅支援華北2(北京)、華東1(杭州)、華南1(深圳)、華東2(上海)、華北3(張家口)、西南1(成都)、美國(矽谷)、美國(維吉尼亞)、德國(法蘭克福)、日本(東京)、中國(香港)、新加坡。
-
許可權控制:僅開放平台管理員和租用戶系統管理員、阿里雲主帳號或者擁有AliyunDataWorksFullAccess許可權的RAM使用者擁有開發人員背景讀寫權限,許可權控制詳情請參見全域級模組許可權控制、產品及控制台許可權控制詳情:RAM Policy。
-
關聯產品:OpenEvent通過EventBridge實現訊息的訂閱與消費,需提前開通事件匯流排EventBridge。
相關概念
DataWorks事件訊息按照是否可在DataWorks形成流程卡點,分為普通事件和擴充點事件。
-
普通事件:您可以在本地開發程式用於接收該類型的事件訊息,以便您基於自身業務進行個人化響應。
-
擴充點事件:相容普通事件特性與能力,此外,該類型事件還支援將本地程式註冊為DataWorks擴充程式,以此實現通過擴充程式對DataWorks中的使用者操作行為進行自訂邏輯處理並實現攔截阻斷等行為管控。
DataWorks事件訊息按照事件生效範圍,將事件劃分空間級事件和租戶級事件。
-
空間級事件:空間級模組產生的事件為空白間級事件,例如資料開發模組中對節點運行產生的事件訊息、營運中心模組周期執行個體狀態變更產生的事件訊息等。
-
租戶級事件:租戶級模組產生的事件為租戶級事件,例如管控台刪除空間所產生的事件訊息。您可通過下文各模組事件列表瞭解各個模組支援的事件訊息中,哪些為普通事件,哪些為擴充點事件,以及對應事件的發送的訊息格式。
支援的事件類型
下表為空白間級和租戶級分別支援的擴充點事件和普通事件。
租戶級事件
管控台
管控台訊息格式詳情請參見:管控台事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
刪除專案空間 |
刪除專案空間前置事件 |
|
|
使用者在工作空間列表刪除某個工作空間前,將觸發該事件。同時,刪除專案空間前置事件還會觸發相應擴充程式進行流程卡點。 |
|
刪除空間後置 |
|
|
上傳與下載
上傳與下載訊息格式詳情請參見:上傳與下載事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
資料下載與上傳 |
資料下載前置事件-檔案產生 |
|
|
當使用者在下載中心進行資料下載操作。 在實際的資料下載操作之前,會觸發資料下載前置事件,以擷取即將進行的下載操作的相關資訊。 |
|
資料下載前置事件-檔案下載 |
|
|
||
|
資料上傳前置事件 |
|
|
空間級事件
管控台
管控台訊息格式詳情請參見:管控台事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
添加使用者到工作空間 |
添加使用者到工作空間 |
|
|
使用者在工作空間中新增成員時,將觸發該事件。批量新增N名成員會產生N條獨立事件。 |
資料開發
資料開發訊息格式詳情請參見:資料開發事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
節點變更 |
新增節點 |
|
|
建立節點發布生產 |
|
更新節點 |
|
|
|
|
|
檔案變更
|
檔案刪除前置事件 |
|
|
開發環境刪除檔案,被刪除的檔案將清除。 |
|
檔案提交前置事件 |
|
|
在DataStudio提交某個節點、資源或函數。 |
|
|
檔案發布前置事件 |
|
|
在DataStudio發布某個已提交節點、資源或函數。 |
|
|
代碼運行前置事件 |
|
|
在DataStudio運行節點代碼。 |
|
|
表變更 |
表提交到開發前置事件 |
|
|
表提交擴充點事件:例如在表管理中提交某個表。 |
|
表提交到生產前置事件 |
|
|
表發布擴充點事件:例如在表管理中發布某個表。 說明
僅標準模式工作空間支援在表管理中發行資料表,因此表發布擴充點事件僅存在於標準模式下。 |
Data Integration
Data Integration訊息格式詳情請參見:Data Integration事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
節點變更事件 |
開啟即時任務 |
|
|
在Data Integration啟動即時任務。 |
|
批量開啟即時任務 |
|
|
在Data Integration大量啟動即時任務。 |
營運中心
營運中心訊息格式詳情請參見:營運中心事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
節點變更 |
刪除節點 |
|
|
|
|
節點下線前置事件 |
|
|
生產環境周期任務直接下線節點。 說明
該操作會同步刪除資料開發中的節點,並清除。 |
|
|
節點凍結前置事件 |
|
|
周期任務介面凍結任務。 |
|
|
節點解凍前置事件 |
|
|
周期任務介面解凍任務。 |
|
|
節點補資料 |
補資料前置事件 |
|
|
|
|
任務狀態變更 |
調度任務狀態變更 |
|
|
如下情境會觸發調度任務狀態變更事件:
|
|
執行個體變更 |
凍結執行個體 |
|
|
在營運中心的周期執行個體列表對某個執行個體進行以下操作後,會觸發相應事件。
|
|
解凍執行個體 |
|
|
||
|
終止執行個體 |
|
|
||
|
重跑執行個體
|
|
|
||
|
置成功執行個體 |
|
|
||
|
移除執行個體指定上遊依賴 |
|
|
||
|
凍結執行個體前置事件 |
|
|
在營運中心的周期執行個體列表對某個執行個體單擊某個操作時,會觸發相應前置事件。
|
|
|
解凍執行個體前置事件 |
|
|
||
|
重跑執行個體前置事件 |
|
|
||
|
置成功執行個體前置事件 |
|
|
||
|
殺死執行個體前置事件 |
|
|
||
|
刪除到期執行個體 |
|
|
||
|
工作流程狀態變更 |
工作流程狀態變更
|
|
|
|
|
監控警示 |
監控警示 |
|
|
|
資訊安全中心
資訊安全中心訊息格式詳情請參見:資訊安全中心事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
申請單建立/審批 |
建立許可權申請單前置事件 |
|
|
例如在資訊安全中心內,頁面對函數、表、資源,進行許可權申請單的建立。 |
|
完成申請單 |
|
|
例如在資訊安全中心內頁面,審批所有專案下的表、資源和函數的許可權。 |
|
|
表許可權變更 |
表許可權申請 |
|
|
例如使用者根據需求申請特定表的讀取、寫入、修改等許可權。 |
資料品質
資料品質訊息格式詳情請參見:資料品質事件列表。
|
事件類型 |
事件 |
普通事件 |
擴充點事件 |
樣本(產生事件訊息的操作) |
|
資料品質校正 |
校正結果反饋 |
|
|
使用者對校正結果的反饋。 例如,在資料治理的資料品質模組,給某個表啟用了錶行數大於0的規則,頁面上使用者可以對某次校正結果進行反饋,當使用者執行了反饋操作,系統會把使用者反饋的內容(校正規則ID、反饋內容等)發送給訂閱端。 |
|
校正完成 |
|
|
規則校正完畢發送規則校正結果(是否通過、樣本等資訊) 例如,在資料治理的資料品質模組,給某個表啟用了錶行數大於0的規則,觸發了規則並且規則校正完畢,會把規則校正結果(是否通過、樣本等資訊)發送給訂閱端。 |
|
|
資料品質規則前置 |
大量建立資料品質規則前置事件 |
|
|
例如在資料品質內,進入頁面的某個表詳情頁。在規則管理頁簽進行如下操作時,會觸發相應前置事件。
|
|
批次更新資料品質規則前置事件 |
|
|
||
|
大量刪除資料品質規則前置事件 |
|
|
||
|
更新資料品質規則前置事件 |
|
|
||
|
資料品質監控前置 |
建立資料品質監控前置事件 |
|
|
例如在資料品質內,進入頁面的某個表詳情頁。在品質監控頁簽進行如下操作時,會觸發相應前置事件。
|
|
更新資料品質監控前置事件 |
|
|
||
|
複製資料品質監控前置事件 |
|
|
||
|
大量刪除資料品質監控前置事件 |
|
|
||
|
資料品質監控警示訂閱前置 |
建立資料品質監控警示訂閱前置事件 |
|
|
例如在資料品質內,進入頁面的某個表詳情頁。在品質監控頁簽中對某個品質監控進行警示訂閱。 |
|
更新資料品質監控警示訂閱前置事件 |
|
|
例如在資料品質內,進入頁面的某個表詳情頁。在品質監控頁簽中對某個品質監控的警示訂閱資訊進行修改。 |
|
|
刪除資料品質監控警示訂閱前置事件 |
|
|
例如在資料品質內,進入頁面的某個表詳情頁。在品質監控頁簽中對某個品質監控的警示訂閱資訊進行刪除。 |