Use GetIDEEventDetail to query the data snapshot of an extension point event - DataWorks - Alibaba Cloud - DataWorks

Queries the extension point data snapshot at the time an extension point event was triggered, based on the message ID of a DataWorks open message.

Operation description

Before you begin: Activate DataWorks Enterprise Edition or Ultimate Edition before calling this operation. If the edition is not activated, the service returns a 403 Forbidden.Access error.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MessageId	string	Yes	The message ID of the DataWorks open message. After an extension point event is triggered, you can obtain the message ID from the received event message.	8abcb91f-d266-4073-b907-2ed67****1
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can obtain the workspace ID by parsing the DataWorks open message.	10000

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The unique ID of the request, which can be used for troubleshooting.	8abcb91f-d266-4073-b907-2ed670378ed1
EventDetail	object	The data snapshot at the time the extension point event was triggered. Different types of message events have different valid fields in the data snapshot. For details, refer to the field descriptions of each message event.
FileExecutionCommand	object	The snapshot when file code is executed. This field is valid only when 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 snapshot information when a file is deleted. This field is valid only when 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 snapshot when a file is committed or deployed. This field is valid only when 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 ID of the Alibaba Cloud account that is used to generate the file of the current 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 that corresponds to the file.
RerunMode	string	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
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 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
DependentNodeIdList	string	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
ResourceGroupId	integer	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
AutoRerunTimes	integer	The number of times that the node corresponding to the file can be rerun.	3
AutoRerunIntervalMillis	integer	The interval at which the node corresponding to the file is rerun. Unit: milliseconds.	120000
CronExpress	string	The CRON expression that is used to schedule the node corresponding to the file.	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 snapshot when a table is committed or deployed. This field is valid only when 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: day.	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.