OpenEvent概述
DataWorks的OpenEvent旨在將DataWorks的各類狀態(tài)變更情況以消息的方式觸達(dá)到用戶，便于用戶訂閱消息并做出個(gè)性化的響應(yīng)。例如，您可以通過OpenEvent訂閱表變更，從而實(shí)現(xiàn)核心表的實(shí)時(shí)監(jiān)控；通過OpenEvent訂閱任務(wù)變更，實(shí)現(xiàn)定制化開發(fā)實(shí)時(shí)任務(wù)大屏的數(shù)據(jù)監(jiān)控。本文為您介紹OpenEvent支持訂閱的事件類型與配置流程。
前提條件
目前OpenEvent面向DataWorks企業(yè)版用戶，華北2（北京）、華東1（杭州）、華南1（深圳）、華東2（上海）、華北3（張家口）、華南1（深圳）、西南1（成都）、美國（硅谷）、美國（弗吉尼亞）、德國（法蘭克福）、日本（東京）、中國（香港）、新加坡地域支持該功能。
OpenEvent通過EventBridge實(shí)現(xiàn)消息的訂閱與消費(fèi)，所以您需要先開通EventBridge產(chǎn)品服務(wù)，關(guān)于EventBridge產(chǎn)品介紹詳情請參見：什么是事件總線EventBridge。
權(quán)限說明
開放平臺管理員和租戶管理員擁有開發(fā)者后臺的讀寫權(quán)限，其他租戶級角色、空間級角色僅擁有開發(fā)者后臺的只讀權(quán)限。詳情請參見全局級模塊權(quán)限控制。
僅支持阿里云主賬號或者擁有AliyunDataWorksFullAccess權(quán)限的RAM用戶進(jìn)行界面相關(guān)配置，權(quán)限詳情請參見產(chǎn)品及控制臺權(quán)限控制詳情：RAM Policy。
背景信息
DataWorks已開放DataWorks側(cè)核心流程的狀態(tài)變更消息，并支持將消息推送至OpenEvent服務(wù)，您可通過DataWorks的OpenEvent模塊對空間消息進(jìn)行推送管理，并結(jié)合事件總線EventBridge服務(wù)實(shí)現(xiàn)DataWorks事件消息的過濾與消費(fèi)管理。
相關(guān)概念
DataWorks事件消息按照是否可在DataWorks形成流程卡點(diǎn)，分為普通事件和擴(kuò)展點(diǎn)事件。
普通事件：您可以在本地開發(fā)程序用于接收該類型的事件消息，以便您基于自身業(yè)務(wù)進(jìn)行個(gè)性化響應(yīng)。
擴(kuò)展點(diǎn)事件：兼容普通事件特性與能力，此外，該類型事件還支持將本地程序注冊為DataWorks擴(kuò)展程序，以此實(shí)現(xiàn)通過擴(kuò)展程序?qū)ataWorks中的用戶操作行為進(jìn)行自定義邏輯處理并實(shí)現(xiàn)攔截阻斷等行為管控。
DataWorks事件消息按照事件生效范圍，將事件劃分空間級事件和租戶級事件。
空間級事件：空間級模塊生成的是事件為空間級事件，例如數(shù)據(jù)開發(fā)模塊中對節(jié)點(diǎn)運(yùn)行產(chǎn)生的事件消息、運(yùn)維中心模塊周期實(shí)例狀態(tài)變更產(chǎn)生的事件消息等。
租戶級事件：租戶級模塊生成的是事件為租戶級事件，例如管控臺刪除空間所產(chǎn)生的事件消息。您可通過下文各模塊事件列表了解各個(gè)模塊支持的事件消息中，哪些為普通事件，哪些為擴(kuò)展點(diǎn)事件，以及對應(yīng)事件的發(fā)送的消息格式。
支持訂閱的事件類型
下表為空間級和租戶級分別支持的擴(kuò)展點(diǎn)事件和普通事件。
空間級事件
數(shù)據(jù)開發(fā)消息格式詳情請參見：數(shù)據(jù)開發(fā)事件列表。
事件類型 （點(diǎn)擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | 示例 |
節(jié)點(diǎn)相關(guān) | 新增節(jié)點(diǎn) |
|
| 新建節(jié)點(diǎn)發(fā)布生產(chǎn) |
更新節(jié)點(diǎn) |
|
|
| |
文件相關(guān)
| 刪除文件 |
|
|
|
提交文件 |
|
| 在DataStudio提交某個(gè)節(jié)點(diǎn)、資源或函數(shù)。 | |
發(fā)布文件 |
|
| 在DataS tudio發(fā)布某個(gè)已提交節(jié)點(diǎn)、資源或函數(shù)。 | |
運(yùn)行代碼 |
|
| 在DataStudio運(yùn)行節(jié)點(diǎn)代碼。 | |
節(jié)點(diǎn)代碼評審 |
|
| 在DataStudio團(tuán)隊(duì)成員可以在代碼提交前對代碼進(jìn)行評審，并提供評價(jià)和反饋。 | |
表相關(guān) | 表提交開發(fā)環(huán)境 |
|
| 表提交擴(kuò)展點(diǎn)事件：例如在表管理中提交某個(gè)表。 |
表發(fā)布生產(chǎn)環(huán)境 |
|
| 表發(fā)布擴(kuò)展點(diǎn)事件：例如在表管理中發(fā)布某個(gè)表。 說明 僅標(biāo)準(zhǔn)模式工作空間支持在表管理中發(fā)布表，因此表發(fā)布擴(kuò)展點(diǎn)事件僅存在于標(biāo)準(zhǔn)模式下。 |
運(yùn)維中心消息格式詳情請參見：運(yùn)維中心事件列表。
事件類型 （點(diǎn)擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | 示例 |
節(jié)點(diǎn)變更 | 刪除節(jié)點(diǎn) |
|
|
|
下線節(jié)點(diǎn) |
|
| 周期任務(wù)界面下線任務(wù)。 | |
凍結(jié)節(jié)點(diǎn) |
|
| 周期任務(wù)界面凍結(jié)任務(wù)。 | |
解凍節(jié)點(diǎn) |
|
| 周期任務(wù)界面解凍任務(wù)。 | |
節(jié)點(diǎn)補(bǔ)數(shù)據(jù) | 節(jié)點(diǎn)補(bǔ)數(shù)據(jù) |
|
|
|
任務(wù)狀態(tài)變更 | 調(diào)度任務(wù)狀態(tài)變更 |
|
| 如下場景會觸發(fā)調(diào)度任務(wù)狀態(tài)變更事件：
|
實(shí)例運(yùn)維 | 凍結(jié)實(shí)例 |
|
| 在運(yùn)維中心對某個(gè)實(shí)例進(jìn)行以下操作。
|
解凍實(shí)例 |
|
| ||
終止實(shí)例 |
|
| ||
重跑實(shí)例
|
|
| ||
置成功實(shí)例 |
|
| ||
工作流狀態(tài)變更 | 工作流狀態(tài)變更
|
|
|
|
監(jiān)控告警 | 監(jiān)控告警 |
|
|
|
安全中心消息格式詳情請參見：安全中心事件列表。
事件類型 （點(diǎn)擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | 示例 |
審批中心 | 創(chuàng)建申請單 |
|
| 例如在數(shù)據(jù)地圖中，在權(quán)限管理頁面單擊申請函數(shù)和資源權(quán)限，進(jìn)行申請單的創(chuàng)建。 |
完成申請單 |
|
| 例如在數(shù)據(jù)地圖中，當(dāng)訪問賬號為管理員時(shí)，在權(quán)限管理頁面單擊待我審批選項(xiàng)卡，審批所有項(xiàng)目下的表、資源和函數(shù)的權(quán)限。 | |
安全中心 | 表權(quán)限申請 |
|
| 例如用戶根據(jù)需求申請?zhí)囟ū淼淖x取、寫入、修改等權(quán)限。 |
數(shù)據(jù)質(zhì)量消息格式詳情請參見：數(shù)據(jù)質(zhì)量事件列表。
事件類型 （點(diǎn)擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | 示例 |
數(shù)據(jù)質(zhì)量校驗(yàn) | 校驗(yàn)結(jié)果反饋 |
|
| 用戶對校驗(yàn)結(jié)果的反饋。 例如，在數(shù)據(jù)治理的數(shù)據(jù)質(zhì)量模塊，給某個(gè)表啟用了表行數(shù)大于0的規(guī)則，頁面上用戶可以對某次校驗(yàn)結(jié)果進(jìn)行反饋，當(dāng)用戶執(zhí)行了反饋操作，系統(tǒng)會把用戶反饋的內(nèi)容（校驗(yàn)規(guī)則ID、反饋內(nèi)容等）發(fā)送給訂閱端。 |
校驗(yàn)完成 |
|
| 規(guī)則校驗(yàn)完畢發(fā)送規(guī)則校驗(yàn)結(jié)果（是否通過、樣本等信息） 例如，在數(shù)據(jù)治理的數(shù)據(jù)質(zhì)量模塊，給某個(gè)表啟用了表行數(shù)大于0的規(guī)則，觸發(fā)了規(guī)則并且規(guī)則校驗(yàn)完畢，會把規(guī)則校驗(yàn)結(jié)果（是否通過、樣本等信息）發(fā)送給訂閱端。 |
租戶級事件
管控臺消息格式詳情請參見：管控臺事件列表。
事件類型 （點(diǎn)擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | 示例 |
刪除項(xiàng)目空間 | 刪除空間前置 |
|
| 用戶在工作空間列表刪除某個(gè)工作空間前，將觸發(fā)該事件。同時(shí)，刪除項(xiàng)目空間前置事件還會觸發(fā)相應(yīng)擴(kuò)展程序進(jìn)行流程卡點(diǎn) |
刪除空間后置 |
|
|
上傳與下載消息格式詳情請參見：上傳與下載事件列表。
事件類型 （單擊查看消息格式） | 事件 | 普通事件 | 擴(kuò)展點(diǎn)事件 | |
數(shù)據(jù)下載與上傳 | 數(shù)據(jù)下載前置-文件生成 |
|
| 當(dāng)用戶在下載中心進(jìn)行數(shù)據(jù)下載操作。 在實(shí)際的數(shù)據(jù)下載操作之前，會觸發(fā)數(shù)據(jù)下載前置事件，以獲取即將進(jìn)行的下載操作的相關(guān)信息。 |
數(shù)據(jù)下載前置-文件下載 |
|
| ||
數(shù)據(jù)上傳前置 |
|
|
應(yīng)用優(yōu)勢
DataWorks的OpenEvent具備以下優(yōu)勢：
節(jié)省運(yùn)維成本：
通過開啟DataWorks開放平臺的消息訂閱功能，您可以很方便地訂閱事件消息。
提升開發(fā)效能：
通過在DataWorks界面上創(chuàng)建相關(guān)配置，您無需再進(jìn)行發(fā)送消息相關(guān)配置，僅需做好相關(guān)SDK開發(fā)的準(zhǔn)備配置工作及訂閱消息配置，節(jié)省繁雜的手工操作。
實(shí)現(xiàn)個(gè)性化需求：
DataWorks提供豐富的事件類型，您可以通過訂閱不同事件類型的消息，快速感知業(yè)務(wù)狀態(tài)變化信息，及時(shí)做好個(gè)性化響應(yīng)和決策。