本トピックでは、DataWorks のイベントタイプ、メッセージフォーマット、およびフィールドの意味について説明します。このドキュメントを使用して、イベントリストとメッセージフォーマットに関する情報を迅速に検索および照会できます。
はじめに
DataWorks では、イベントは、DataWorks 内でチェックポイントを作成できるかどうか、および自己管理型サービスによってサブスクライブされた後に処理結果を返すことができるかどうかに基づいて、標準イベントまたは拡張ポイントイベントに分類されます。
-
標準イベント:これらのイベントメッセージをサブスクライブできますが、DataWorks 内の操作をブロックすることはできません。これらのイベントは OpenEvent を使用してサブスクライブします。詳細については、「OpenEvent」をご参照ください。
-
拡張ポイントイベント:これらのイベントメッセージをサブスクライブした後、DataWorks オープンプラットフォームの拡張機能を使用して、イベントメッセージへの応答をカスタマイズできます。拡張機能を使用して拡張ポイントでの操作を管理する場合、その拡張ポイントで DataWorks プラットフォームユーザーが実行した操作は、カスタム拡張が処理結果を返すまで中断されます。
このリストでは、サポートされているイベントをモジュール別に分類し、各イベントが標準イベントか拡張ポイントイベントかを示します。また、EventBridge イベントタイプ (Type) と拡張イベントコード (eventCode) もリストアップしています。
-
EventBridge イベントタイプ (Type): イベントメッセージをフィルターするために使用されるフィールドです。詳細については、「メッセージサブスクリプションの有効化」をご参照ください。
-
拡張イベントコード (eventCode):イベントタイプに対応するイベントコードです。ローカル開発中に、DataWorks から送信されたメッセージ内容からこのコードを取得して、ターゲットのイベントタイプを識別します。
ワークスペースレベルのイベント
ワークスペースレベルのモジュールによって生成されるイベントはワークスペースレベルのイベントです。たとえば、データ開発でのノード実行やオペレーションセンターでの定期インスタンスのステータス変更などです。以下のイベントリストを使用して、どのイベントが標準イベントで、どのイベントが拡張ポイントイベントであるか、およびそれらのメッセージフォーマットを識別します。
以下のメッセージフォーマットタブには、一部の内容のみが含まれています。EventBridge または Function Compute に送信される完全なメッセージについては、「付録:メッセージフォーマット」をご参照ください。
データ開発のイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントコード (eventCode) |
|
ノード変更 |
ノードの作成
|
|
|
|
|
|
ノードの更新
|
|
|
|
|
|
|
ファイル変更
|
ファイル削除前イベント 開発環境でノードを削除 説明
削除されたファイルはごみ箱に移動します。 |
|
|
|
|
|
ファイルコミット前イベント |
|
|
|
|
|
|
ファイルデプロイ前イベント |
|
|
|
|
|
|
実行前イベント |
|
|
|
|
|
|
テーブル変更 |
開発環境へのテーブル送信前イベント |
|
|
|
|
|
本番環境へのテーブルデプロイ前イベント |
|
|
|
|
メッセージフォーマット
ノード変更イベント (作成、更新)
ファイル変更イベント (コミット、デプロイ、実行、削除)
テーブル変更イベント (開発環境へのテーブルコミット、本番環境へのテーブルデプロイ)
データ統合のイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントタイプ (eventCode) |
|
ノード変更イベント |
ジョブの開始 |
|
|
|
|
|
ジョブの一括開始 |
|
|
|
|
メッセージフォーマット
ノード変更イベント-ジョブの開始
ノード変更イベント-ジョブの一括開始
オペレーションセンターのイベントリスト
イベントリスト
スケジューリングリソースグループまたは所有者を変更すると、node-change-updated がトリガーされます。
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントタイプ (eventCode) |
|
ノード変更 |
ノードの削除
|
|
|
|
|
|
ノード非公開前イベント 本番環境で定期ノードを直接非公開にする 説明
この操作により、データ開発のノードが同期的に削除され、ごみ箱に移動します。 |
|
|
|
|
|
|
ノードフリーズ前イベント 重要
このイベントは、node-change-updated イベントを同期的にトリガーします。 |
|
|
|
|
|
|
ノードフリーズ解除前イベント 重要
このイベントは、node-change-updated イベントを同期的にトリガーします。 |
|
|
|
|
|
|
データ補填 |
データ補填前イベント |
|
|
|
|
|
タスクステータス変更 |
スケジューリングタスクのステータス変更 |
|
|
|
|
|
インスタンス変更 |
インスタンスのフリーズ |
|
|
|
|
|
インスタンスのフリーズ解除 |
|
|
|
|
|
|
インスタンスの強制終了 |
|
|
|
|
|
|
インスタンスの再実行
|
|
|
|
|
|
|
成功したインスタンス |
|
|
|
|
|
|
インスタンスから指定された上流依存関係を削除 |
|
|
|
|
|
|
インスタンスフリーズ前イベント |
|
|
|
|
|
|
インスタンスフリーズ解除前イベント |
|
|
|
|
|
|
インスタンス再実行前イベント |
|
|
|
|
|
|
インスタンス成功設定前イベント |
|
|
|
|
|
|
インスタンス強制終了前イベント |
|
|
|
|
|
|
期限切れインスタンスの削除 |
|
|
|
|
|
|
ワークフローステータス変更 |
ワークフローステータス変更
|
|
|
|
|
|
監視とアラート |
監視とアラート |
|
|
|
|
メッセージフォーマット
ノード変更イベント (削除、非公開、フリーズ、フリーズ解除)
データ補填
タスクステータス変更イベント
インスタンス変更イベント (フリーズ、フリーズ解除、強制終了、再実行、成功設定)
インスタンス変更前イベント (フリーズ、フリーズ解除、再実行、成功設定、インスタンス強制終了)
インスタンス変更イベント-期限切れインスタンスの削除
指定された上流依存関係の削除イベント
ワークフローステータス変更イベント
監視とアラート
セキュリティセンターのイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張メッセージタイプ (eventCode) |
|
承認センター |
権限申請フォーム作成前イベント |
|
|
|
|
|
申請フォームの完了 |
|
|
|
|
|
|
セキュリティセンター (テーブル権限申請) |
テーブル権限申請前イベント |
|
|
|
|
メッセージフォーマット
承認センター (申請フォームの作成、完了)
セキュリティセンター (テーブル権限申請前イベント)
付録:権限付与内容リスト (MaxCompute)
付録:権限付与内容リスト (DataService)
Data Quality のイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントタイプ (eventCode) |
|
データ品質検証 |
検証結果のフィードバック
|
|
|
|
|
|
検証完了
|
|
|
|
|
|
|
データ品質ルールの事前チェック |
データ品質ルールの一括作成前イベント |
|
|
|
|
|
データ品質ルールの一括更新前イベント |
|
|
|
|
|
|
データ品質ルールの一括削除前イベント |
|
|
|
|
|
|
データ品質ルール更新前イベント |
|
|
|
|
|
|
データ品質監視の事前操作 |
データ品質監視作成前イベント |
|
|
|
|
|
データ品質監視更新前イベント |
|
|
|
|
|
|
データ品質監視クローン前イベント |
|
|
|
|
|
|
データ品質監視の一括削除前イベント |
|
|
|
|
|
|
データ品質監視アラートサブスクリプションの事前操作 |
データ品質監視アラートサブスクリプション作成前イベント |
|
|
|
create-data-quality-evaluation-task-notification |
|
データ品質監視アラートサブスクリプション更新前イベント |
|
|
|
|
|
|
データ品質監視アラートサブスクリプション削除前イベント |
|
|
|
|
メッセージフォーマット
データ品質検証
データ品質ルールの事前操作イベント (一括作成、更新、削除)
データ品質監視の事前操作イベント (作成、更新、クローン、一括削除)
データ品質監視アラートサブスクリプションの事前操作イベント (作成、更新、削除)
テナントレベルのイベント
テナントレベルのモジュールは、テナントレベルのイベントを生成します。たとえば、管理コンソールでワークスペースを削除するときに生成されるイベントなどです。以下のイベントリストを使用して、どのイベントが標準イベントで、どのイベントが拡張ポイントイベントであるか、およびそれらのメッセージフォーマットを識別します。
以下のメッセージフォーマットタブには、一部の内容のみが含まれています。EventBridge または Function Compute に送信される完全なメッセージについては、「付録:メッセージフォーマット」をご参照ください。
管理コンソールのイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントタイプ (eventCode) |
|
プロジェクトスペースの削除 |
プロジェクトスペース削除前イベント |
|
|
|
|
|
末尾のスペースを削除します。 |
|
|
|
|
メッセージフォーマット
メッセージペイロードフォーマット:プロジェクトスペース削除イベント
アップロードおよびダウンロードのイベントリスト
イベントリスト
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントタイプ (eventCode) |
|
データのアップロードとダウンロード |
データダウンロード事前イベント - ファイル生成 |
|
|
dataworks:ResourcesDownload:DownloadResources |
download-resources |
|
データダウンロード事前イベント - ファイルダウンロード |
|
|
dataworks:ResourcesDownload:DownloadResourcesExecute |
download-resources-execute |
|
|
データアップロード事前イベント |
|
|
dataworks:ResourcesUpload:UploadDataToTable |
upload-data-to-table |
メッセージフォーマット
データのアップロードとダウンロード
付録:メッセージフォーマット
EventBridge のメッセージフォーマット
OpenEvent を設定し、イベント配信チャネルを追加した後、DataWorks でワークスペースレベルまたはテナントレベルのイベントがトリガーされると、メッセージは EventBridge で設定されたイベントタイプ (Type) に基づいてフィルタリングされます。以下に、DataWorks がイベント配信チャネルを通じて EventBridge に送信するメッセージフォーマットを示します。
{
"datacontenttype": "application/json;charset=utf-8",// data パラメーターの内容のフォーマット。datacontenttype は application/json フォーマットのみをサポートします。
"data": {
// メッセージ内容はメッセージタイプによって異なります。以下はすべてのイベントメッセージに含まれる 2 つの固定フィールドです。各イベントメッセージの詳細については、上記をご参照ください。
"tenantId": 28378****10656,// テナント ID。DataWorks の各 Alibaba Cloud アカウントは 1 つのテナントに対応し、各テナントには独自のテナント ID があります。この値は、DataWorks データ開発の右上にあるユーザー情報で確認できます。
"eventCode": "xxxx"//
},
"id": "539fd8f4-4ea1-4625-aa8b-6c906674****",// イベント ID。イベントの一意の識別子。
"source": "acs.dataworks",// イベントソース、イベントを提供するサービス。このメッセージが DataWorks によってプッシュされたことを示します。
"specversion": "1.0",
"subject": "",
"time": "2020-11-19T21:04:41+08:00",// イベントが発生した時刻。
"type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",// イベントタイプ。このイベントタイプは、EventBridge コンソールで DataWorks によってプッシュされたすべてのメッセージをフィルタリングするために使用できます。各イベントには異なる Type 値があります。さまざまなイベントメッセージタイプについては、上記をご参照ください。
"aliyunaccountid": "123456789098****",// Alibaba Cloud アカウント ID
"aliyunpublishtime": "2020-11-19T21:04:42.179PRC",// EventBridge がイベントを受信した時刻。
"aliyuneventbusname": "default",// DataWorks イベントメッセージを受信する EventBridge イベントバスの名前。
"aliyunregionid": "cn-hangzhou",// イベントを受信するリージョン。
"aliyunpublishaddr": "172.25.XX.XX"
}
完全なイベントメッセージには、メッセージペイロードフォーマットと、メッセージ ID、ソース、発生時刻などの基本情報が含まれます。重要なフィールドの説明を次の表に示します。
|
フィールド名 |
フィールドタイプ |
説明 |
|
data |
object |
メッセージペイロードフォーマット。メッセージフォーマットとフィールドの意味はイベントタイプによって異なります。詳細については、以下をご参照ください: データ開発イベントメッセージフォーマット:「データ開発のイベントリスト」。 データ統合イベントメッセージフォーマット:「データ統合のイベントリスト」。 オペレーションセンターイベントメッセージフォーマット:「オペレーションセンターのイベントリスト」。 セキュリティセンターイベントメッセージフォーマット:「セキュリティセンターのイベントリスト」。 Data Quality イベントメッセージフォーマット:「Data Quality のイベントリスト」。 |
|
id |
String |
イベントメッセージの一意の ID。イベントメッセージを特定するために使用されます。 |
|
type |
String |
イベントタイプ。イベントソースに関連するイベントタイプを記述します。値の例:
このイベントタイプは、EventBridge コンソールで DataWorks によってプッシュされたすべてのメッセージをフィルタリングするために使用できます。各イベントには異なる Type 値があります。さまざまなイベントメッセージタイプについては、上記をご参照ください。 |
Function Compute のメッセージフォーマット
DataWorks で Function Compute を使用して 拡張機能を設定すると、DataWorks は対応する拡張ポイントイベントのメッセージを JSON 形式で Function Compute に送信します。以下に、Function Compute に送信されるメッセージフォーマットを示します。
{
"blockBusiness": true,
"eventCategoryType": "resources-download",// イベントカテゴリ
"eventType": "upload-data-to-table",// イベントタイプ
"extensionBizId": "job_6603***070",
"messageBody": {
// メッセージ内容はメッセージタイプによって異なります。以下はすべてのイベントメッセージに含まれる 2 つの固定フィールドです。各イベントメッセージの詳細については、上記をご参照ください。
"tenantId": 28378****10656,// テナント ID。DataWorks の各 Alibaba Cloud アカウントは 1 つのテナントに対応し、各テナントには独自のテナント ID があります。この値は、DataWorks データ開発の右上にあるユーザー情報で確認できます。
"eventCode": "xxxx"//
},
"messageId": "52d44ee7-b51f-4d4d-afeb-*******"// イベント ID。イベントの一意の識別子。
}
重要なフィールドの説明は以下の通りです:
|
フィールド名 |
フィールドタイプ |
説明 |
|
|
messageId |
String |
イベント ID、イベントの一意の識別子。 |
|
|
messageBody |
DataWorks によってプッシュされた特定のイベントメッセージ。拡張機能の開発で使用できます。メッセージ内容はメッセージタイプによって異なります。 |
||
|
tenantId |
テナント ID。DataWorks の各 Alibaba Cloud アカウントは 1 つのテナントに対応し、各テナントには独自のテナント ID があります。この値は、DataWorks データ開発の右上にあるユーザー情報で確認できます |
||
|
eventCode |
イベントコード。特定のタイプのイベントメッセージを識別するために使用されます。各イベントタイプに対応する eventCode の値については、「開発リファレンス:イベントリストとメッセージフォーマット」テーブルの拡張イベントタイプ (eventCode) 列をご参照ください。 |
||