すべてのプロダクト
Search

このプロダクト

    DataWorks:GetIDEEventDetail

    ドキュメントセンター

    DataWorks:GetIDEEventDetail

    最終更新日:Mar 21, 2026

    DataWorks OpenEvent で拡張ポイントイベントがトリガーされた際に、そのメッセージ ID を基に拡張ポイントのデータスナップショットを照会します。

    操作説明

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    MessageId

    string

    必須

    DataWorks OpenEvent のメッセージ ID です。拡張ポイントイベントがトリガーされた際に受信したメッセージから取得できます。

    8abcb91f-d266-4073-b907-2ed67****1
    ProjectId

    integer

    必須

    DataWorks ワークスペース ID です。メッセージから取得できます。

    10000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答です。

    RequestId

    string

    リクエスト ID です。

    8abcb91f-d266-4073-b907-2ed670378ed1
    EventDetail

    object

    拡張ポイントイベントがトリガーされた際に生成されるデータスナップショットです。

    データスナップショットに含まれるフィールドは、トリガーされた拡張ポイントイベントのタイプによって異なります。詳細については、各フィールドの説明をご参照ください。

    FileExecutionCommand

    object

    ファイル内のコードが実行された際のデータスナップショットです。このパラメーターは、メッセージタイプが IDE_FILE_EXECUTE_BEFORE の場合にのみ有効です。

    FileId

    integer

    ファイル ID です。

    1234123
    DataSourceName

    string

    ファイルに関連付けられたデータソースの名前です。

    odps_source
    Content

    string

    現在のバージョンのファイル内のコードです。

    SHOW TABLES;
    FileType

    integer

    ファイルのコードタイプです。ファイルタイプによってコード内容が異なります。詳細については、「DataWorks ノード」をご参照ください。

    10
    DeletedFile

    object

    ファイルが削除された際のデータスナップショットです。このパラメーターは、メッセージタイプが IDE_FILE_DELETE_BEFORE の場合にのみ有効です。

    Owner

    string

    ファイル所有者です。

    7384234****
    FileType

    integer

    ファイルのコードタイプです。ファイルタイプによってコード内容が異なります。詳細については、「DataWorks ノード」をご参照ください。

    10
    CurrentVersion

    integer

    ファイルの最新バージョン番号です。

    1
    BusinessId

    integer

    ファイルが属するワークフローの ID です。

    74328
    FileName

    string

    ファイル名です。

    hello_dataworks.sql
    DataSourceName

    string

    ファイルに関連付けられたデータソースの名前です。

    odps_source
    UseType

    string

    ファイルが属するモジュールです。有効値は以下のとおりです。

    • NORMAL：ファイルは DataStudio で使用されます。

    • MANUAL：ファイルは手動トリガーノードで使用されます。

    • MANUAL_BIZ：ファイルは手動トリガーワークフローで使用されます。

    • SKIP：ファイルはドライラン DataStudio ノードで使用されます。

    • ADHOCQUERY：ファイルはアドホッククエリで使用されます。

    • COMPONENT：ファイルはスニペットで使用されます。

    NORMAL
    FolderId

    string

    ファイルが属するフォルダの ID です。フォルダ ID を指定して GetFolder 操作を呼び出すことで、ファイルの詳細を照会できます。

    aldurie78l2falure
    ParentFileId

    integer

    ファイルに対応する do-while ノードまたは for-each ノードの ID です。

    1234122
    Content

    string

    現在のバージョンのファイル内のコードです。

    SHOW TABLES;
    NodeId

    integer

    スケジュールされたノードの ID です。

    421429
    FileId

    integer

    ファイル ID です。

    1234123
    CommittedFile

    object

    ファイルがコミットおよびデプロイされた際のデータスナップショットです。

    このパラメーターは、メッセージタイプが IDE_FILE_SUBMIT_BEFORE または IDE_FILE_DEPLOY_BEFORE の場合にのみ有効です。

    FileId

    integer

    ファイル ID です。

    1234123
    Content

    string

    現在のバージョンのファイル内のコードです。

    SHOW TABLES;
    Committor

    string

    現在のバージョンのファイルを生成するために使用された Alibaba Cloud アカウントの ID です。

    7384234****
    FileType

    integer

    ファイルのコードタイプです。ファイルタイプによってコード内容が異なります。詳細については、「DataWorks ノード」をご参照ください。

    10
    ChangeType

    string

    現在のバージョンのファイルに対する変更タイプです。有効値は CREATE、UPDATE、DELETE です。

    UPDATE
    FileName

    string

    ファイル名です。

    hello_dataworks.sql
    NodeId

    integer

    スケジュールされたノードの ID です。

    421429
    Comment

    string

    ファイルバージョンの説明です。

    Second version submission
    UseType

    string

    ファイルが属するモジュールです。有効値は以下のとおりです。

    • NORMAL：ファイルは DataStudio で使用されます。

    • MANUAL：ファイルは手動トリガーノードで使用されます。

    • MANUAL_BIZ：ファイルは手動トリガーワークフローで使用されます。

    • SKIP：ファイルはドライラン DataStudio ノードで使用されます。

    • ADHOCQUERY：ファイルはアドホッククエリで使用されます。

    • COMPONENT：ファイルはスニペットで使用されます。

    NORMAL
    FilePropertyContent

    object

    ファイルの詳細情報です。

    DataSourceName

    string

    ファイルに関連付けられたデータソースの名前です。

    odps_source
    ParentFileId

    integer

    ファイルに対応する do-while ノードまたは for-each ノードの ID です。

    1234122
    BusinessId

    integer

    ファイルが属するワークフローの ID です。

    74328
    CurrentVersion

    integer

    ファイルの最新バージョン番号です。

    1
    Owner

    string

    ファイル所有者です。

    7384234****
    FolderId

    string

    ファイルが属するフォルダの ID です。フォルダ ID を指定して GetFolder 操作を呼び出すことで、ファイルの詳細を照会できます。

    aldurie78l2falure
    NodeConfiguration

    object

    ファイルに対応するノードのスケジューリングプロパティです。

    RerunMode

    string

    ファイルに対応するノードを再実行できるかどうかを示します。有効値は以下のとおりです。

    • ALL_ALLOWED：成功・失敗を問わず、ノードを再実行できます。

    • FAILURE_ALLOWED：ノードが失敗した場合にのみ、再実行できます。

    • ALL_DENIED：成功・失敗を問わず、ノードを再実行できません。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [スケジュール] セクションにある [再実行] パラメーターに対応しています。

    ALL_ALLOWED
    SchedulerType

    string

    ノードのスケジューリングタイプです。有効値は以下のとおりです。

    • NORMAL：ノードは自動トリガーノードです。

    • MANUAL：ノードは手動トリガーノードです。手動トリガーノードは自動的にトリガーされません。「手動トリガーワークフロー」ペインのノードに対応します。

    • PAUSE：ノードは一時停止ノードです。

    • SKIP：ノードはドライランノードです。ドライランノードはスケジュールどおりに開始されますが、実行開始時にシステムがノードのステータスを成功に設定します。

    NORMAL
    ParaValue

    string

    ノードのスケジューリングパラメーターです。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [スケジューリングパラメーター] セクションに対応しています。スケジューリングパラメーターの構成方法の詳細については、「スケジューリングパラメーターの設定」をご参照ください。

    a=x b=y
    CycleType

    string

    ファイルに対応するノードのスケジューリングサイクルタイプです。有効値は NOT_DAY および DAY です。NOT_DAY は、ノードが分または時間単位でスケジュールされることを示します。DAY は、ノードが日、週、または月単位でスケジュールされることを示します。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [スケジュール] セクションにある [スケジューリングサイクル] パラメーターに対応しています。

    DAY
    DependentNodeIdList

    string

    DependentType パラメーターが USER_DEFINE に設定されている場合に、ファイルに対応するノードが依存するノードの ID です。複数の ID はカンマ (,) で区切ります。

    このパラメーターの値は、DataWorks コンソール の [プロパティ] タブの [依存関係] セクションで「クロスサイクル依存関係 (元の前サイクル依存関係)」の「他のノード」を選択した後に指定したノードの ID と同等です。

    5,10,15,20
    ResourceGroupId

    integer

    ファイルに対応するノードの実行に使用されるリソースグループの ID です。ListResourceGroups 操作を呼び出すことで、ワークスペース内で利用可能なリソースグループを照会できます。

    375827434852437
    AutoRerunTimes

    integer

    ファイルに対応するノードを再実行できる回数です。

    3
    AutoRerunIntervalMillis

    integer

    ファイルに対応するノードを再実行する間隔です。単位はミリ秒です。

    120000
    CronExpress

    string

    ファイルに対応するノードをスケジュールするために使用される CRON 式です。

    00 05 00 * * ?
    InputList

    array<object>

    現在のファイルが依存する親ファイルの出力名です。

    object

    現在のファイルが依存する親ファイルの出力情報です。

    Input

    string

    現在のファイルが依存する親ファイルの出力名です。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [依存関係] セクションにある [親ノード] の下の [先祖ノードの出力名] パラメーターに対応しています。

    dw_project_root
    ParseType

    string

    構成ファイル依存関係のモードです。有効値は以下のとおりです。

    • MANUAL：スケジューリング依存関係は手動で構成されます。

    • AUTO：スケジューリング依存関係は自動的に解析されます。

    MANUAL
    OutputList

    array<object>

    現在のファイルの出力名です。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [依存関係] セクションにある [現在のノードの出力名] パラメーターに対応しています。

    object

    現在のファイルの出力情報です。

    RefTableName

    string

    現在のファイルの出力テーブル名です。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [依存関係] セクションにある [現在のノードの出力名] の下の [出力テーブル名] パラメーターに対応しています。

    ods_user_info_d
    Output

    string

    現在のファイルの出力名です。

    このパラメーターは、DataWorks コンソール の [プロパティ] タブの [依存関係] セクションにある [現在のノードの出力名] の下の [出力名] パラメーターに対応しています。

    dw_project.002_out
    DependentType

    string

    ノードのクロスサイクルスケジューリング依存関係タイプです。有効値は以下のとおりです。

    • SELF：現在のサイクルで生成されたノードのインスタンスは、前のサイクルで生成されたノードのインスタンスに依存します。

    • CHILD：現在のサイクルで生成されたノードのインスタンスは、前のサイクルで生成されたノードの最寄りレベルの子孫ノードのインスタンスに依存します。

    • USER_DEFINE：現在のサイクルで生成されたノードのインスタンスは、前のサイクルで生成された 1 つ以上の指定されたノードのインスタンスに依存します。

    • NONE：ノードに対してクロスサイクルスケジューリング依存関係タイプが選択されていません。

    USER_DEFINE
    TableModel

    object

    テーブルがコミットおよびデプロイされた際のデータスナップショットです。このパラメーターは、メッセージタイプが IDE_TABLE_SUBMIT_BEFORE または IDE_TABLE_DEPLOY_BEFORE の場合にのみ有効です。

    Env

    string

    テーブルが使用される環境です。有効値は以下のとおりです。

    • DEV

    • PROD

    DEV
    LifeCycle

    integer

    メタテーブルのライフサイクルです。単位は日です。

    7
    TableName

    string

    テーブル名です。

    tb_hello
    DataSourceName

    string

    テーブルが属するデータソースの名前です。

    odps_source
    Columns

    array<object>

    テーブル内のカラムです。

    object

    テーブル内のカラムです。

    ColumnName

    string

    カラム名です。

    ID
    ColumnType

    string

    カラムのデータの型です。

    BIGINT
    IsPartitionColumn

    boolean

    カラムがパーティションキー列かどうかを示します。有効値は以下のとおりです。

    • true：カラムはパーティションキー列です。

    • false：カラムはパーティションキー列ではありません。

    false
    Comment

    string

    カラムの備考です。

    ID
    Comment

    string

    テーブルの備考です。

    A new table
    Location

    string

    テーブルのパスです。

    hdfs://path/to/object

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_source",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_source",
      "UseType": "NORMAL",
      "FolderId": "aldurie78l2falure",
      "ParentFileId": 1234122,
      "Content": "SHOW TABLES;",
      "NodeId": 421429,
      "FileId": 1234123
    },
    "CommittedFile": {
      "FileId": 1234123,
      "Content": "SHOW TABLES;",
      "Committor": "7384234****",
      "FileType": 10,
      "ChangeType": "UPDATE",
      "FileName": "hello_dataworks.sql",
      "NodeId": 421429,
      "Comment": "Second version submission",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_source",
        "ParentFileId": 1234122,
        "BusinessId": 74328,
        "CurrentVersion": 1,
        "Owner": "7384234****",
        "FolderId": "aldurie78l2falure"
      },
      "NodeConfiguration": {
        "RerunMode": "ALL_ALLOWED",
        "SchedulerType": "NORMAL",
        "ParaValue": "a=x b=y",
        "CycleType": "DAY",
        "DependentNodeIdList": "5,10,15,20",
        "ResourceGroupId": 375827434852437,
        "AutoRerunTimes": 3,
        "AutoRerunIntervalMillis": 120000,
        "CronExpress": "00 05 00 * * ?",
        "InputList": [
          {
            "Input": "dw_project_root",
            "ParseType": "MANUAL"
          }
        ],
        "OutputList": [
          {
            "RefTableName": "ods_user_info_d",
            "Output": "dw_project.002_out"
          }
        ],
        "DependentType": "USER_DEFINE"
      }
    },
    "TableModel": {
      "Env": "DEV",
      "LifeCycle": 7,
      "TableName": "tb_hello",
      "DataSourceName": "odps_source",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "A new table",
      "Location": "hdfs://path/to/object"
    }
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InternalError.UserId.Missing An internal system error occurred. Try again later.
    500 InternalError.System An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。