OpenEvent モジュールを使用すると、イベントメッセージをサブスクライブできます。 DataWorks のさまざまな変更イベントに関する通知を受信し、構成に基づいてできるだけ早くイベントに対応できます。 たとえば、テーブル変更イベントをサブスクライブして、コアテーブルへの変更に関する通知をリアルタイムで受信できます。 また、タスク変更イベントをサブスクライブして、リアルタイム同期タスクのステータスを表示するダッシュボードのカスタムデータ監視を実装することもできます。 このトピックでは、OpenEvent を使用してサブスクリプションするイベントの種類と、サブスクリプション構成手順の実行について説明します。
前提条件
サポートされているリージョンで DataWorks Enterprise Edition が有効化されていること。 OpenEvent モジュールは、中国 (北京)、中国 (杭州)、中国 (上海)、中国 (張家口)、中国 (深圳)、中国 (成都)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、日本 (東京)、中国 (香港)、シンガポールの DataWorks Enterprise Edition ユーザーが利用できます。
EventBridge が有効化されていること。 OpenEvent モジュールは、EventBridge を使用してメッセージをサブスクライブおよび消費します。 詳細については、「EventBridge とは」をご参照ください。
権限の説明
[オープン プラットフォーム管理者] と [テナント管理者] は、[開発者バックエンド] に対する読み取りおよび書き込み権限を持っています。 その他のテナントレベルのロールとワークスペースレベルのロールは、開発者バックエンドに対する読み取り専用権限を持っています。 詳細については、「グローバルレベルのサービスに対する権限を管理する」をご参照ください。
[aliyundataworksfullaccess] ポリシーがアタッチされている Alibaba Cloud アカウントまたは RAM ユーザーのみが、DataWorks コンソールのページで設定を構成するために使用できます。 詳細については、「RAM ポリシーを使用して DataWorks サービスおよび DataWorks コンソールのエンティティに対する権限を管理する」をご参照ください。
背景情報
DataWorks では、DataWorks の主要プロセスにおけるステータス変更イベントのメッセージをサブスクライブし、DataWorks オープン プラットフォームの OpenEvent モジュールにメッセージをプッシュできます。 OpenEvent モジュールを使用して、ワークスペース内のイベントメッセージをプッシュし、EventBridge を使用してメッセージをフィルタリングおよび消費できます。
概念
DataWorks イベントは、DataWorks のイベントに関連する操作プロセスをブロックできるかどうかによって、標準イベントと拡張ポイントイベントに分類されます。
[標準イベント]: このイベントタイプのメッセージを受信するオンプレミプログラムを開発し、ビジネス要件に基づいてイベントメッセージへのカスタムレスポンスを構成できます。
[拡張ポイントイベント]: このタイプのイベントは、標準イベントの特性と機能を備えています。 さらに、このタイプのイベントでは、オンプレミスプログラムを DataWorks 拡張機能として登録し、操作のブロックなど、カスタム処理ロジックに基づいて DataWorks で実行した操作によって生成されたイベントメッセージを処理できます。
DataWorks イベントは、イベントの有効範囲に基づいて、ワークスペースレベルのイベントとテナントレベルのイベントに分類されます。
ワークスペースレベルのイベント: ワークスペースレベルのサービスで生成されるイベント。たとえば、DataStudio でノードが実行されたときに生成されるイベント、およびオペレーションセンターでインスタンスのステータスが変更されたときに生成されるイベントは、ワークスペースレベルのイベントです。
テナントレベルのイベント: テナントレベルのサービスで生成されるイベント。 たとえば、ユーザーが DataWorks コンソールでワークスペースを削除したときに生成されるイベントは、テナントレベルのイベントです。 次の表に、各 DataWorks サービスでサポートされているイベント、イベントが標準イベントか拡張ポイントイベントか、およびイベントのメッセージ形式を示します。
サポートされているイベントタイプ
次の表に、ワークスペースレベルとテナントレベルでサポートされている拡張ポイントイベントと標準イベントを示します。
ワークスペースレベルのイベント
[DataStudio] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「DataStudio のイベント」セクションをご参照ください。
イベントカテゴリ | イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
ノード変更イベント | ノードを作成する |
|
| ノードを作成し、本番環境にデプロイします。 |
ノードを更新する |
|
|
| |
ファイル変更イベント
| ファイルを削除する |
|
| 開発環境でファイルを削除します。 削除されたファイルを [ゴミ箱] に移動します。 |
ファイルを送信する |
|
| [DataStudio] でノード、リソース、または関数をコミットします。 | |
ファイルをデプロイする |
|
| [DataStudio] でノード、リソース、または関数をデプロイします。 | |
ノードのコードを実行する |
|
| [DataStudio] でノードのコードを実行します。 | |
テーブル変更イベント | テーブルを開発環境にコミットする |
|
| [DataStudio] の [ワークスペース テーブル] ページでテーブルをコミットします。 |
テーブルを本番環境にデプロイする |
|
| [DataStudio] の [ワークスペース テーブル] ペインでテーブルをデプロイします。 説明 [ワークスペース テーブル] ペインでテーブルをデプロイできるのは、[標準モード] のワークスペースのみです。 したがって、テーブルデプロイイベントは、[標準モード] のワークスペースでのみ生成できます。 |
Data Integration のイベントのメッセージ形式については、「開発リファレンス：イベントリストとイベントメッセージ形式」トピックのData Integration のイベントセクションを参照してください。
イベントカテゴリ | イベント | 標準イベント | 拡張ポイントイベント | 例（イベント生成操作） |
ノード変更イベント | DI ジョブ実行の前イベント |
|
| Data Integration でリアルタイムタスクを開始します。 |
DI ジョブバッチ実行の前イベント |
|
| Data Integration でリアルタイムタスクのバッチを開始します。 |
[オペレーションセンター] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「オペレーションセンターのイベント」セクションをご参照ください。
イベントカテゴリ | イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
ノードの変更 | ノードを削除する |
|
|
|
ノードをアンデプロイする |
|
| 本番環境で自動トリガーノードをアンデプロイします。 説明 この操作では、[DataStudio] のノードが削除され、[ゴミ箱] に移動されます。 | |
ノードをフリーズする |
|
| [オペレーションセンター] の [自動トリガーノード] ページでノードをフリーズします。 | |
ノードのフリーズを解除する |
|
| [オペレーションセンター] の [自動トリガーノード] ページでノードのフリーズを解除します。 | |
ノードのデータバックフィル | ノードのデータをバックフィルする |
|
|
|
ノードステータスの変更 | 自動トリガーノードのステータスを変更する |
|
| スケジューリングタスクステータス変更イベントは、次のシナリオで生成できます。
|
インスタンス変更イベント | インスタンスをフリーズする |
|
| オペレーションセンターで自動トリガーインスタンスに対して次のいずれかの操作を実行すると、対応するイベントがトリガーされます。
|
インスタンスのフリーズを解除する |
|
| ||
インスタンスを終了する |
|
| ||
インスタンスを再実行する
|
|
| ||
インスタンスステータスを成功に設定 |
|
| ||
インスタンスの指定された [祖先インスタンス] を削除する |
|
| ||
インスタンスフリーズの前イベント |
|
| オペレーションセンターで自動トリガーインスタンスに対して次のいずれかの操作を実行すると、対応するイベントがトリガーされます。
| |
インスタンスフリーズ解除の前イベント |
|
| ||
インスタンス再実行の前イベント |
|
| ||
インスタンス成功設定の前イベント |
|
| ||
インスタンス強制終了の前イベント |
|
| ||
期限切れのインスタンスの削除 |
|
| ||
ワークフローステータスの変更 | ワークフローのステータスを変更する
|
|
|
|
監視とアラート | オブジェクトを監視し、アラートを送信する |
|
|
|
[セキュリティセンター] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「セキュリティセンターのイベント」セクションをご参照ください。
イベントカテゴリ | イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
リクエスト注文の作成または処理 | 承認注文作成前のイベント |
|
| [セキュリティセンター] の [データアクセス制御] ページの [権限申請] タブで、[関数]、[テーブル]、または [リソース] のリクエスト次数を作成します。 |
リクエスト注文を完了する |
|
| [セキュリティセンター] の [データアクセス制御] ページの [権限申請処理] タブで、テーブル、リソース、または関数のリクエスト次数を処理します。 | |
テーブル権限の変更 | テーブルの権限をリクエストする |
|
| ビジネス要件に基づいて、特定のテーブルに対する読み取り、書き込み、および変更の権限を申請します。 |
[Data Quality] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「Data Quality のイベント」セクションをご参照ください。
イベントカテゴリ | イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
データ品質チェック | データ品質チェック結果に関するフィードバックを提供する |
|
| [Data Quality] でチェック結果に関するフィードバックを提供します。 たとえば、[Data Quality] で特定のテーブルの行数が 0 を超えているかどうかをチェックするために使用する監視ルールを有効にします。 ルールがトリガーされ、チェックが完了すると、ユーザーはチェック結果に関するフィードバックを提供できます。 フィードバックが提供されると、システムは監視ルール ID やフィードバックコンテンツなどの情報を含むフィードバックをサブスクライバーに送信します。 |
データ品質チェックの完了を報告する |
|
| チェックの合格 とサンプリング情報を含むデータ品質チェック結果を送信します。 たとえば、[Data Quality] で特定のテーブルの行数が 0 を超えているかどうかをチェックするために使用する監視ルールを有効にします。 ルールがトリガーされ、チェックが完了すると、システムはチェック結果をサブスクライバーに送信します。 チェック結果には、データが品質チェックに合格したかどうかと、使用されたサンプルが含まれています。 | |
データ品質ルールのプリイベント | データ品質ルール一括作成のプリイベント |
|
| たとえば、[データ品質] モジュールで、 ページに移動し、特定のテーブルの詳細ページを開きます。 [ルール管理] タブで、次の操作を実行すると、対応するプリイベントがトリガーされます。
|
データ品質ルール一括更新の事前イベント |
|
| ||
データ品質ルールの一括削除の事前イベント |
|
| ||
データ品質ルールの更新前イベント |
|
| ||
データ品質評価タスクの事前イベント | データ品質評価タスク作成の事前イベント |
|
| たとえば、[データ品質] モジュールで、 ページに移動し、特定のテーブルの詳細ページを開きます。 [監視] タブで、次の操作を実行すると、対応する事前イベントがトリガーされます。
|
データ品質評価タスク更新の事前イベント |
|
| ||
データ品質評価タスククローン用のイベント前処理 |
|
| ||
データ品質評価タスクのバッチ削除の事前イベント |
|
| ||
データ品質評価タスク通知の事前イベント | データ品質評価タスク通知作成の事前イベント |
|
| たとえば、[データ品質] モジュールで、 ページに移動し、特定のテーブルの詳細ページを開きます。 [モニター] タブで、特定のデータ品質モニターのアラートをサブスクライブします。 |
データ品質評価タスク通知更新の事前イベント |
|
| たとえば、[データ品質] モジュールで、 ページに移動し、特定のテーブルの詳細ページを開きます。[監視] タブで、特定のデータ品質モニターのアラート サブスクリプション設定を変更します。 | |
データ品質評価タスク通知削除の事前イベント |
|
| たとえば、[データ品質] モジュールで、 ページに移動し、特定のテーブルの詳細ページを開きます。 [監視] タブで、特定のデータ品質モニターのアラートサブスクリプションを削除します。 |
テナントレベルのイベント
[DataWorks コンソール] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「DataWorks コンソールのイベント」セクションをご参照ください。
イベントカテゴリ
| イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
ワークスペースの削除 | ワークスペースを削除する (事前イベント) |
|
| ユーザーが [ワークスペース] ページでワークスペースを削除する前に、ワークスペース削除の事前イベントが生成されます。 [ワークスペース削除の事前イベント] は、関連する拡張機能をトリガーしてプロセスをブロックできます。 |
ワークスペースを削除する (事後イベント) |
|
|
[アップロードとダウンロード] のイベントのメッセージ形式については、「開発リファレンス: イベントリストとイベントメッセージ形式」トピックの「アップロードとダウンロードのイベント」セクションをご参照ください。
イベントカテゴリ
| イベント | 標準イベント | 拡張ポイントイベント | 例 (イベント生成操作) |
データのダウンロードとアップロード | データをダウンロードする (事前イベント) (ファイル生成) |
|
| [アップロードとダウンロード] でデータをダウンロードまたはアップロードすると、データのダウンロードまたはアップロードイベントが生成されます。 データをダウンロードする前に、[データダウンロードの事前イベント] が生成され、ダウンロード操作に関する情報が取得されます。 |
データをダウンロードする (事前イベント) (ファイルダウンロード) |
|
| ||
データをアップロードする (事前イベント) |
|
|
アプリケーションのメリット
OpenEvent モジュールには次のメリットがあります。
低い O&M コスト:
DataWorks オープン プラットフォームでメッセージ [サブスクリプション] 機能を有効にすると、DataWorks イベントを簡単に [サブスクライブ] できます。
メッセージの送受信効率の向上:
メッセージ [サブスクリプション] のパラメーターを構成し、SDK 開発の準備をするだけで済みます。 これにより、手動操作が削減され、簡素化されます。
さまざまなニーズへの対応:
さまざまなタイプの DataWorks イベントを [サブスクライブ] できます。 これにより、重要な DataWorks の変更を特定し、できるだけ早く変更に対応できます。