All Products
Search

This Product

    DataWorks:GetIDEEventDetail

    Document Center

    DataWorks:GetIDEEventDetail

    Last Updated:Jul 18, 2024

    Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    MessageIdstringYes

    The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.

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

    The DataWorks workspace ID. You can obtain the ID from the message.

    		10000

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    The data snapshot that is generated when an extension point event is triggered.

    The fields contained in data snapshots vary based on the types of the triggered extension point events. For more information, see the description of the fields.

    FileExecutionCommandobject

    The data snapshot when the code in the file is run. This parameter is valid only if the message type is IDE_FILE_EXECUTE_BEFORE.

    FileIdlong

    The file ID.

    		1234123
    DataSourceNamestring

    The name of the data source with which the file is associated.

    		odps_first
    Contentstring

    The code in the file of the current version.

    		SHOW TABLES;
    FileTypelong

    The type of the code for the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).

    		10
    DeletedFileobject

    The data snapshot when the file is deleted. This parameter is valid only if the message type is IDE_FILE_DELETE_BEFORE.

    Ownerstring

    The file owner.

    		7384234****
    FileTypelong

    The type of the code for the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).

    		10
    CurrentVersionlong

    The latest version number of the file.

    		1
    BusinessIdlong

    The ID of the workflow to which the file belongs.

    		74328
    FileNamestring

    The name of the file.

    		hello_dataworks.sql
    DataSourceNamestring

    The name of the data source with which the file is associated.

    		odps_first
    UseTypestring

    The module to which the file belongs. Valid values:

    • NORMAL: The file is used for DataStudio.
    • MANUAL: The file is used for a manually triggered node.
    • MANUAL_BIZ: The file is used for a manually triggered workflow.
    • SKIP: The file is used for a dry-run DataStudio node.
    • ADHOCQUERY: The file is used for an ad hoc query.
    • COMPONENT: The file is used for a snippet.
    		NORMAL
    FolderIdstring

    The ID of the folder to which the file belongs. You can call the GetFolder operation to query the details of the file based on the folder ID.

    		aldurie78l2falure
    ParentFileIdlong

    The ID of the do-while node or for-each node that corresponds to the file.

    		1234122
    Contentstring

    The code in the file of the current version.

    		SHOW TABLES;
    NodeIdlong

    The ID of the node that is scheduled.

    		421429
    FileIdlong

    The file ID.

    		1234123
    CommittedFileobject

    The data snapshot when the file is committed and deployed.

    This parameter is valid only if the message type is IDE_FILE_SUBMIT_BEFORE or IDE_FILE_DEPLOY_BEFORE.

    FileIdlong

    The file ID.

    		1234123
    Contentstring

    The code in the file of the current version.

    		SHOW TABLES;
    Committorstring

    The ID of the Alibaba Cloud account that is used to generate the file of the current version.

    		7384234****
    FileTypelong

    The type of the code for the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).

    		10
    ChangeTypestring

    The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.

    		UPDATE
    FileNamestring

    The name of the file.

    		hello_dataworks.sql
    NodeIdlong

    The ID of the node that is scheduled.

    		421429
    Commentstring

    The description of the file version.

    UseTypestring

    The module to which the file belongs. Valid values:

    • NORMAL: The file is used for DataStudio.
    • MANUAL: The file is used for a manually triggered node.
    • MANUAL_BIZ: The file is used for a manually triggered workflow.
    • SKIP: The file is used for a dry-run DataStudio node.
    • ADHOCQUERY: The file is used for an ad hoc query.
    • COMPONENT: The file is used for a snippet.
    		NORMAL
    FilePropertyContentobject

    The details of the file.

    DataSourceNamestring

    The name of the data source with which the file is associated.

    		odps_first
    ParentFileIdlong

    The ID of the do-while node or for-each node that corresponds to the file.

    		1234122
    BusinessIdlong

    The ID of the workflow to which the file belongs.

    		74328
    CurrentVersionlong

    The latest version number of the file.

    		1
    Ownerstring

    The file owner.

    		7384234****
    FolderIdstring

    The ID of the folder to which the file belongs. You can call the GetFolder operation to query the details of the file based on the folder ID.

    		aldurie78l2falure
    NodeConfigurationobject

    The scheduling properties of the node that corresponds to the file.

    RerunModestring

    Indicates whether the node that corresponds to the file can be rerun. Valid values:

    • ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.
    • FAILURE_ALLOWED: The node can be rerun only after it fails to run.
    • ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.

    This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the DataWorks console.

    		ALL_ALLOWED
    SchedulerTypestring

    The scheduling type of the node. Valid values:

    • NORMAL: The node is an auto triggered node.
    • MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.
    • PAUSE: The node is a paused node.
    • SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.
    		NORMAL
    ParaValuestring

    The scheduling parameters of the node.

    This parameter corresponds to the Scheduling Parameter section of the Properties tab in the DataWorks console. For more information about the configurations of the scheduling parameters, see Configure scheduling parameters.

    		a=x b=y
    CycleTypestring

    The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.

    This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the DataWorks console.

    		DAY
    DependentNodeIdListstring

    The ID of the node on which the node that corresponds to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).

    The value of this parameter is equivalent to the ID of the node that you specified after you select Other Nodes for Cross-Cycle Dependency (Original Previous-Cycle Dependency) in the Dependencies section of the Properties tab in the DataWorks console.

    		5,10,15,20
    ResourceGroupIdlong

    The ID of the resource group that is used to run the node that corresponds to the file. You can call the ListResourceGroups operation to query the available resource groups in the workspace.

    		375827434852437
    AutoRerunTimeslong

    The number of times that the node corresponding to the file can be rerun.

    		3
    AutoRerunIntervalMillislong

    The interval at which the node corresponding to the file is rerun. Unit: milliseconds.

    		120000
    CronExpressstring

    The CRON expression that is used to schedule the node corresponding to the file.

    		00 05 00 * * ?
    InputListarray<object>

    The output names of the parent files on which the current file depends.

    object
    Inputstring

    The output name of the parent file on which the current file depends.

    This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes in the Dependencies section of the Properties tab in the DataWorks console.

    		dw_project_root
    ParseTypestring

    The mode of the configuration file dependency. Valid values:

    • MANUAL: Scheduling dependencies are manually configured.
    • AUTO: Scheduling dependencies are automatically parsed.
    		MANUAL
    OutputListarray<object>

    The output names of the current file.

    This parameter corresponds to the Output Name of Current Node parameter in the Dependencies section of the Properties tab in the DataWorks console.

    object
    RefTableNamestring

    The output table name of the current file.

    This parameter corresponds to the Output Table Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the DataWorks console.

    		ods_user_info_d
    Outputstring

    The output name of the current file.

    This parameter corresponds to the Output Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the DataWorks console.

    		dw_project.002_out
    DependentTypestring

    The type of the cross-cycle scheduling dependency of the node. Valid values:

    • SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.
    • CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.
    • USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.
    • NONE: No cross-cycle scheduling dependency type is selected for the node.
    		USER_DEFINE
    TableModelobject

    The data snapshot when the table is committed and deployed. This parameter is valid only if the message type is IDE_TABLE_SUBMIT_BEFORE or IDE_TABLE_DEPLOY_BEFORE.

    Envstring

    The environment in which the table is used. Valid values:

    • DEV
    • PROD
    		DEV
    LifeCyclelong

    The lifecycle of the metatable. Unit: day.

    		7
    TableNamestring

    The name of the table.

    		tb_hello
    DataSourceNamestring

    The name of the data source to which the table belongs.

    		odps_first
    Columnsarray<object>

    The columns in the table.

    object
    ColumnNamestring

    The name of the column.

    		ID
    ColumnTypestring

    The data type of the column.

    		BIGINT
    IsPartitionColumnboolean

    Indicates whether the column is a partition key column. Valid values:

    • true
    • false
    		false
    Commentstring

    The remarks of the column.

    		ID
    Commentstring

    The remarks of the table.

    Locationstring

    The path of the table.

    		hdfs://path/to/object

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_first",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_first",
      "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": "",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_first",
        "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_first",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "",
      "Location": "hdfs://path/to/object"
    }
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InternalError.UserId.MissingAn internal system error occurred. Try again later.-
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
    429Throttling.ApiThe request for this resource has exceeded your available limit.-
    429Throttling.SystemThe DataWorks system is busy. Try again later.-
    429Throttling.UserYour request is too frequent. Try again later.-
    500InternalError.SystemAn internal system error occurred. Try again later.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history