このトピックでは、DataWorks のイベントタイプ、メッセージフォーマット、およびフィールドの意味について説明します。このドキュメントを使用して、イベント一覧とメッセージフォーマットに関する情報を迅速に検索および照会できます。
概要
DataWorks では、イベントは DataWorks 内でチェックポイントを作成できるかどうか、およびセルフマネージドサービスによるサブスクライブ後に処理結果を返すことができるかどうかに基づいて、標準イベントまたは拡張ポイントイベントに分類されます。
-
標準イベント:これらのイベントメッセージをサブスクライブできますが、DataWorks 内での操作をブロックすることはできません。これらのイベントは OpenEvent を使用してサブスクライブします。詳細については、「OpenEvent」をご参照ください。
-
拡張ポイントイベント:これらのイベントメッセージをサブスクライブした後、DataWorks Open Platform の Extensions 機能を使用してイベントメッセージへの応答をカスタマイズできます。DataWorks プラットフォームユーザーが拡張ポイントで操作を実行する際、Extensions を使用して拡張ポイントでの操作を管理すると、カスタム拡張機能が処理結果を返すまで、その拡張ポイントでの操作が中断されます。
以下のリストでは、サポートされているイベントをモジュール別に分類し、各イベントが 標準イベント または 拡張ポイントイベント のいずれであるかを示しています。また、EventBridge イベントタイプ (Type) および 拡張イベントコード (eventCode) も記載されています。
-
EventBridge イベントタイプ (Type): イベントメッセージをフィルタリングするために使用されるフィールドです。詳細については、「メッセージサブスクリプションの有効化」をご参照ください。
-
拡張イベントコード (eventCode):イベントタイプに対応するイベントコードです。ローカル開発中は、DataWorks から送信されたメッセージコンテンツからこのコードを取得し、対象のイベントタイプを識別します。
ワークスペースレベルのイベント
ワークスペースレベルのモジュールによって生成されるイベントは ワークスペースレベルのイベント です。たとえば、Data Studio のノード実行やオペレーションセンターのスケジュールインスタンスステータス変更などがあります。イベント一覧 を使用して、どのイベントが標準イベントであり、どのイベントが拡張ポイントイベントであるかを識別し、それらのメッセージフォーマットを確認してください。
以下の メッセージフォーマットタブ には一部のコンテンツのみが含まれています。EventBridge または Function Compute に送信される完全なメッセージについては、「付録:メッセージフォーマット」をご参照ください。
Data Studio イベント一覧
イベント一覧
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントコード (eventCode) |
|
ノード変更 |
ノード作成
|
|
|
|
|
|
ノード更新
|
|
|
|
|
|
|
ファイル変更
|
ファイル削除の事前イベント 開発環境でノードを削除 説明 削除されたファイルはゴミ箱に移動されます。 |
|
|
|
|
|
ファイルコミットの事前イベント |
|
|
|
|
|
|
ファイルデプロイの事前イベント |
|
|
|
|
|
|
コード実行の事前イベント |
|
|
|
|
|
|
テーブル変更 |
開発環境へのテーブルコミットの事前イベント |
|
|
|
|
|
本番環境へのテーブルデプロイの事前イベント |
|
|
|
|
メッセージフォーマット
ノード変更イベント (作成および更新)
ファイル変更イベント (コミット、デプロイ、実行、および削除)
テーブル変更イベント (開発環境へのテーブルコミットまたは本番環境へのテーブルデプロイ)
Data Integration イベント一覧
イベント一覧
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントコード (eventCode) |
|
ノード変更イベント |
タスク開始 |
|
|
|
|
|
タスクの一括開始 |
|
|
|
|
メッセージフォーマット
ノード変更イベント- タスク開始
ノード変更イベント- タスクの一括開始
オペレーションセンターイベント一覧
イベント一覧
スケジューリングリソースグループを変更するか、所有者を変更すると、node-change-updated がトリガーされます。
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントコード (eventCode) |
|
ノード変更 |
ノード削除
|
|
|
|
|
|
ノードアンデプロイの事前イベント 本番環境のスケジュールタスクから直接ノードをアンデプロイ 説明 この操作により、Data Studio のノードも削除され、ゴミ箱に移動します。 |
|
|
|
|
|
|
ノードフリーズの事前イベント 重要 このイベントは node-change-updated イベントもトリガーします。 |
|
|
|
|
|
|
ノードアンフリーズの事前イベント 重要 このイベントは node-change-updated イベントもトリガーします。 |
|
|
|
|
|
|
ノードバックフィルデータ |
バックフィルデータの事前イベント |
|
|
|
|
|
タスクステータス変更 |
スケジュールタスクステータス変更 |
|
|
|
|
|
インスタンス変更 |
インスタンスフリーズ |
|
|
|
|
|
インスタンスアンフリーズ |
|
|
|
|
|
|
インスタンス終了 |
|
|
|
|
|
|
インスタンス再実行
|
|
|
|
|
|
|
インスタンスを成功に設定 |
|
|
|
|
|
|
インスタンスの指定された上流依存関係を削除 |
|
|
|
|
|
|
インスタンスフリーズの事前イベント |
|
|
|
|
|
|
インスタンスアンフリーズの事前イベント |
|
|
|
|
|
|
インスタンス再実行の事前イベント |
|
|
|
|
|
|
インスタンスを成功に設定する事前イベント |
|
|
|
|
|
|
インスタンス終了の事前イベント |
|
|
|
|
|
|
期限切れインスタンスの削除 |
|
|
|
|
|
|
ワークフローステータス変更 |
ワークフローステータス変更
|
|
|
|
|
|
監視アラート |
監視アラート |
|
|
|
|
メッセージフォーマット
ノード変更イベント (削除、アンデプロイ、フリーズ、およびアンフリーズ)
ノードのバックフィルデータ
タスクステータス変更イベント
インスタンス変更イベント (フリーズ、アンフリーズ、終了、再実行、成功に設定)
インスタンス変更の事前イベント ( フリーズ、アンフリーズ、再実行、成功に設定、インスタンス終了)
インスタンス変更イベント - 期限切れインスタンスの削除
インスタンスから指定された上流依存関係を削除するイベント
ワークフローステータス変更イベント
監視アラート
セキュリティセンターイベントリスト
イベント一覧
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
Extensions イベントコード (eventCode) |
|
承認センター |
権限リクエスト作成の事前イベント |
|
|
|
|
|
リクエスト完了 |
|
|
|
|
|
|
セキュリティセンター (テーブル権限リクエスト) |
テーブル権限リクエストの事前イベント |
|
|
|
|
メッセージフォーマット
承認センター (リクエストの作成および完了)
セキュリティセンター ( テーブル権限リクエスト事前チェックイベント)
付録: 付与コンテンツ一覧 (MaxCompute)
付録: 付与コンテンツ一覧 (Data Service)
Data Quality イベント一覧
イベント一覧
|
イベントタイプ |
イベント (およびトリガー操作) |
標準イベント |
拡張ポイントイベント |
EventBridge イベントタイプ (Type) |
拡張イベントコード (eventCode) |
|
Data Quality チェック |
チェック結果フィードバック
|
|
|
|
|
|
チェック完了
|
|
|
|
|
|
|
Data quality rule pre-event |
Batch create data quality rules pre-event |
|
|
|
|
|
Batch update data quality rules pre-event |
|
|
|
|
|
|
Batch delete data quality rules pre-event |
|
|
|
|
|
|
Update data quality rule pre-event |
|
|
|
|
|
|
Data quality monitoring pre-event |
Create data quality monitoring pre-event |
|
|
|
|
|
Update data quality monitoring pre-event |
|
|
|
|
|
|
Clone data quality monitoring pre-event |
|
|
|
|
|
|
Batch delete data quality monitoring pre-event |
|
|
|
|
|
|
Data quality monitoring alert subscription pre-event |
Create data quality monitoring alert subscription pre-event |
|
|
|
create-data-quality-evaluation-task-notification |
|
Update data quality monitoring alert subscription pre-event |
|
|
|
|
|
|
Delete data quality monitoring alert subscription pre-event |
|
|
|
|
メッセージフォーマット
Data Quality チェック
Extension point events for data quality rules (batch create, update, and delete)
Data quality monitoring pre-events ( create, update, clone, and batch delete)
Data Quality monitoring alert subscription extension point events (create, update, and delete)
Tenant-level events
Events generated by tenant-level modules are tenant-level events, such as events generated when a workspace is deleted from the console. Use the event list below to identify which events are standard events and which are extension point events, along with their message formats.
The following message format tabs contain partial content only. For complete messages sent to EventBridge or Function Compute, refer to Appendix: Message format.
Console event list
Event list
|
Event type |
Event (and triggering operation) |
Standard event |
Extension point event |
EventBridge event type (Type) |
Extensions event type (eventCode) |
|
Delete workspace |
Delete workspace extension point event |
|
|
|
|
|
Post-delete workspace event |
|
|
|
|
Message format
Message entity format: Delete workspace events
Data Upload & Download event list
Event list
|
Event type |
Event (and triggering operation) |
Standard event |
Extension point event |
EventBridge event type (Type) |
Extension event code (eventCode) |
|
Data download and upload |
Pre-event for data download - file generation |
|
|
dataworks:ResourcesDownload:DownloadResources |
download-resources |
|
Pre-event for data download - file download |
|
|
dataworks:ResourcesDownload:DownloadResourcesExecute |
download-resources-execute |
|
|
Pre-event for data upload |
|
|
dataworks:ResourcesUpload:UploadDataToTable |
upload-data-to-table |
Message format
Data download and upload
Appendix: Message format
Message format for EventBridge
After you configure Open Event and add an event distribution channel, when a workspace-level or tenant-level event is triggered in DataWorks, the event is filtered based on the event type (Type) configured in EventBridge. The following is the message format that DataWorks sends to EventBridge through the event distribution channel.
{
"datacontenttype": "application/json;charset=utf-8",// The content format of the data parameter. Only application/json is supported for datacontenttype.
"data": {
// The message content varies depending on the message type. The following two fields are fixed in the message. For event messages, see the preceding sections.
"tenantId": 28378****10656,// The tenant ID. Each Alibaba Cloud account corresponds to a tenant in DataWorks, and each tenant has its own tenant ID. You can view this value in the user information in the upper-right corner of Data Studio in DataWorks.
"eventCode": "xxxx"//
},
"id": "539fd8f4-4ea1-4625-aa8b-6c906674****",// The event ID. A unique value that identifies the event.
"source": "acs.dataworks",// The event source, which is the service that provides the event. This indicates that the message is pushed by DataWorks.
"specversion": "1.0",
"subject": "",
"time": "2020-11-19T21:04:41+08:00",// The time when the event was generated.
"type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",// The event type. You can use this event type to filter all messages pushed by DataWorks in the EventBridge console. The Type value varies for each event. See the preceding sections for different event message types.
"aliyunaccountid": "123456789098****",// The Alibaba Cloud account ID.
"aliyunpublishtime": "2020-11-19T21:04:42.179PRC",// The time when EventBridge received the event.
"aliyuneventbusname": "default",// The name of the EventBridge event bus used to receive DataWorks event messages.
"aliyunregionid": "cn-hangzhou",// The region where the event is received.
"aliyunpublishaddr": "172.25.XX.XX"
}A complete event message includes the message body and basic information such as the message ID, source, and generation time. The following table describes the important fields.
|
Field |
Type |
Description |
|
data |
object |
The message body. The message format and field meanings vary depending on the event type. For more information, see: Data Studio event message format: Data Studio event list. Data Integration event message format: Data Integration event list. Operation Center event message format: Operation Center event list. Security Center event message format: Security Center event list. Data Quality event message format: Data Quality event list. |
|
id |
String |
The unique ID of the event message. This field is used to locate the event message. |
|
type |
String |
The event type. This field describes the event type related to the event source. Examples:
You can use this event type to filter all messages pushed by DataWorks in the EventBridge console. The Type value varies for each event. See the preceding sections for different event message types. |
Message format for Function Compute
When you configure Extensions with the Function Compute method in DataWorks, DataWorks sends event messages in JSON format to Function Compute when the corresponding extension point event is triggered. The following is the message format sent to Function Compute.
{
"blockBusiness": true,
"eventCategoryType": "resources-download",// The event category.
"eventType": "upload-data-to-table",// The event type.
"extensionBizId": "job_6603***070",
"messageBody": {
// The message content varies depending on the message type. The following two fields are fixed in the message. For event messages, see the preceding sections.
"tenantId": 28378****10656,// The tenant ID. Each Alibaba Cloud account corresponds to a tenant in DataWorks, and each tenant has its own tenant ID. You can view this value in the user information in the upper-right corner of Data Studio in DataWorks.
"eventCode": "xxxx"//
},
"messageId": "52d44ee7-b51f-4d4d-afeb-*******"// The event ID. A unique value that identifies the event.
}The following table describes the important fields.
|
Field |
タイプ |
説明 |
|
|
messageId |
String |
イベント ID。イベントを一意に識別する値。 |
|
|
messageBody |
DataWorks によってプッシュされた特定のイベントメッセージ。Extensions の開発時にこのフィールドを使用できます。このフィールドの内容はメッセージタイプによって異なります。 |
||
|
tenantId |
テナント ID。各 Alibaba Cloud アカウントは DataWorks のテナントに対応し、各テナントには独自のテナント ID があります。この値は、DataWorks の Data Studio の右上隅にあるユーザー情報で確認できます。 |
||
|
eventCode |
イベントコード。このフィールドは、特定のタイプのイベントメッセージを識別します。各イベントタイプの eventCode については、イベント一覧 表の Extensions イベントコード (eventCode) 列をご参照ください。 |
||