DocsICP FilingConsole
Documentation
Home Page DataWorks Developer Reference API Reference (2020-05-18) API catalog Data development. GetIDEEventDetail

GetIDEEventDetail

Updated at:
Copy as MD
Product
My Favorites

Retrieves the data snapshot of an extension point event by message ID from DataWorks OpenEvent.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
MessageId

string

Yes

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

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

integer

Yes

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

10000

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

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

object

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

The fields in a data snapshot vary by extension point event type. For more information, see the field descriptions.

FileExecutionCommand

object

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

FileId

integer

The file ID.

1234123
DataSourceName

string

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

odps_source
Content

string

The code in the file of the current version.

SHOW TABLES;
FileType

integer

The type of the code for the file. The code for files varies based on the file type. For more information, see DataWorks nodes.

10
DeletedFile

object

The data snapshot when the file is deleted. Valid only if the message type is IDE_FILE_DELETE_BEFORE.

Owner

string

The file owner.

7384234****
FileType

integer

The type of the code for the file. The code of files varies based on the file type. For more information, see DataWorks nodes.

10
CurrentVersion

integer

The latest version number of the file.

1
BusinessId

integer

The ID of the workflow to which the file belongs.

74328
FileName

string

The name of the file.

hello_dataworks.sql
DataSourceName

string

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

odps_source
UseType

string

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
FolderId

string

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
ParentFileId

integer

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

1234122
Content

string

The code in the file of the current version.

SHOW TABLES;
NodeId

integer

The ID of the node that is scheduled.

421429
FileId

integer

The file ID.

1234123
CommittedFile

object

The data snapshot when the file is committed and deployed.

Valid only if the message type is IDE_FILE_SUBMIT_BEFORE or IDE_FILE_DEPLOY_BEFORE.

FileId

integer

The file ID.

1234123
Content

string

The code in the file of the current version.

SHOW TABLES;
Committor

string

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

7384234****
FileType

integer

The type of the code for the file. The code of files varies based on the file type. For more information, see DataWorks nodes.

10
ChangeType

string

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

UPDATE
FileName

string

The name of the file.

hello_dataworks.sql
NodeId

integer

The ID of the node that is scheduled.

421429
Comment

string

The description of the file version.

Second version submission
UseType

string

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
FilePropertyContent

object

The details of the file.

DataSourceName

string

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

odps_source
ParentFileId

integer

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

1234122
BusinessId

integer

The ID of the workflow to which the file belongs.

74328
CurrentVersion

integer

The latest version number of the file.

1
Owner

string

The file owner.

7384234****
FolderId

string

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
NodeConfiguration

object

The scheduling properties of the node.

RerunMode

string

Specifies whether the node 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
SchedulerType

string

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
ParaValue

string

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
CycleType

string

The scheduling cycle type of the node. Valid values: NOT_DAY and DAY. NOT_DAY indicates scheduling by minute or hour. DAY indicates scheduling 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
DependentNodeIdList

string

The IDs of nodes that the current node depends on when DependentType is set to USER_DEFINE. Separate multiple IDs with 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
ResourceGroupId

integer

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

375827434852437
AutoRerunTimes

integer

The number of times the node can be rerun.

3
AutoRerunIntervalMillis

integer

The rerun interval for the node. Unit: milliseconds.

120000
CronExpress

string

The CRON expression used to schedule the node.

00 05 00 * * ?
InputList

array<object>

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

object

The output information about the parent files on which the current file depends.

Input

string

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
ParseType

string

The mode of the configuration file dependency. Valid values:

  • MANUAL: Scheduling dependencies are manually configured.

  • AUTO: Scheduling dependencies are automatically parsed.

MANUAL
OutputList

array<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

The output information about the current file.

RefTableName

string

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
Output

string

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
DependentType

string

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
TableModel

object

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

Env

string

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

  • DEV

  • PROD

DEV
LifeCycle

integer

The lifecycle of the metatable. Unit: days.

7
TableName

string

The name of the table.

tb_hello
DataSourceName

string

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

odps_source
Columns

array<object>

The columns in the table.

object

The column in the table.

ColumnName

string

The name of the column.

ID
ColumnType

string

The data type of the column.

BIGINT
IsPartitionColumn

boolean

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

  • true: The column is a partition key column.

  • false: The column is not a partition key column.

false
Comment

string

The remarks of the column.

ID
Comment

string

The remarks of the table.

A new table
Location

string

The path of the table.

hdfs://path/to/object

Examples

Success response

JSON format

{
  "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"
    }
  }
}

Error codes

HTTP status code

Error code

Error message

Description
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. No permission, please authorize
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：UpdateIDEEventResultNext：CreateResourceFile