GetIDEEventDetail-DataWorks(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. For the message format, refer to Message format.	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 ID of the file.	1234123
DataSourceName	string	The unique identifier of the data source associated with the file.	odps_source
Content	string	The file code that generated this file version.	SHOW TABLES;
FileType	integer	The file type. Different file types have different code. 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 owner of the file.	7384234****
FileType	integer	The file type. Different file types have different code. For more information, see DataWorks nodes.	10
CurrentVersion	integer	The latest version 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 unique identifier of the data source associated with the file.	odps_source
UseType	string	The functional module to which the file belongs. Valid values: NORMAL: Data Studio. MANUAL: manual task. MANUAL_BIZ: manual workflow. SKIP: dry-run scheduling in Data Studio. ADHOCQUERY: ad hoc query. COMPONENT: component management.	NORMAL
FolderId	string	The ID of the folder to which the file belongs. You can call the GetFolder operation to query file details by folder ID.	aldurie78l2falure
ParentFileId	integer	The node ID of the loop node or traversal node to which the file belongs.	1234122
Content	string	The file code that generated this file version.	SHOW TABLES;
NodeId	integer	The ID of the scheduling node.	421429
FileId	integer	The ID of the file.	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 ID of the file.	1234123
Content	string	The file code that generated this file version.	SHOW TABLES;
Committor	string	The Alibaba Cloud user ID that generated this file version.	7384234****
FileType	integer	The file type. Different file types have different code. For more information, see DataWorks nodes.	10
ChangeType	string	The change type of this file version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileName	string	The name of the file.	hello_dataworks.sql
NodeId	integer	The ID of the scheduling node.	421429
Comment	string	The description of this file version.	Second version submission
UseType	string	The functional module to which the file belongs. Valid values: NORMAL: Data Studio. MANUAL: manual task. MANUAL_BIZ: manual workflow. SKIP: dry-run scheduling in Data Studio. ADHOCQUERY: ad hoc query. COMPONENT: component management.	NORMAL
FilePropertyContent	object	The additional properties of the file.
DataSourceName	string	The unique identifier of the data source associated with the file.	odps_source
ParentFileId	integer	The node ID of the loop node or traversal node to which the file belongs.	1234122
BusinessId	integer	The ID of the workflow to which the file belongs.	74328
CurrentVersion	integer	The latest version of the file.	1
Owner	string	The owner of the file.	7384234****
FolderId	string	The ID of the folder to which the file belongs. You can call the GetFolder operation to query file details by folder ID.	aldurie78l2falure
NodeConfiguration	object	The scheduling configuration of the file.
RerunMode	string	The rerun property. Valid values: ALL_ALLOWED: The node can be rerun regardless of whether it runs successfully or fails. FAILURE_ALLOWED: The node can be rerun only after it fails. ALL_DENIED: The node cannot be rerun regardless of whether it runs successfully or fails. This parameter corresponds to the "Schedule Configuration > Time Properties > Rerun Properties" setting of a Data Studio task in the DataWorks console.	ALL_ALLOWED
SchedulerType	string	The scheduling type. Valid values: NORMAL: normal scheduling task. MANUAL: manual task that is not scheduled on a regular basis. This corresponds to nodes in a manual workflow. PAUSE: paused task. SKIP: dry-run task that is scheduled on a regular basis but is directly set to successful when scheduling starts.	NORMAL
ParaValue	string	The scheduling parameters. This parameter corresponds to the "Schedule Configuration > Parameters" setting of a Data Studio task in the DataWorks console. For more information, see Scheduling parameters.	a=x b=y
CycleType	string	The type of the scheduling cycle. Valid values: NOT_DAY (minute or hour) and DAY (day, week, or month). This parameter corresponds to the "Schedule Configuration > Time Properties > Scheduling Cycle" setting of a Data Studio task in the DataWorks console.	DAY
DependentNodeIdList	string	The IDs of the nodes on which the current file depends when the DependentType parameter settings are set to USER_DEFINE. Separate multiple node IDs with commas (,). This parameter corresponds to the "Schedule Configuration > Scheduling Dependencies > Cross-cycle Dependencies (Previous Cycle)" setting of a Data Studio task in the DataWorks console, when the dependency is set to "Other Nodes".	5,10,15,20
ResourceGroupId	integer	The resource group used when the task is executed after the file is deployed. You can call the ListResourceGroups operation to obtain the list of available resource groups for the workspace.	375827434852437
AutoRerunTimes	integer	The number of automatic reruns.	3
AutoRerunIntervalMillis	integer	The interval between automatic reruns, in milliseconds.	120000
CronExpress	string	The scheduling cron expression.	00 05 00 * * ?
InputList	array<object>	The upstream file outputs on which the file depends.
	object	The information about the upstream file output on which the file depends.
Input	string	The output name of the upstream file on which the file depends. This parameter corresponds to the "Output Name of Upstream Node" in the "Schedule Configuration > Scheduling Dependencies > Depends On Upstream Nodes" setting of a Data Studio task in the DataWorks console.	dw_project_root
ParseType	string	The method used to configure file dependencies. Valid values: MANUAL: manual configuration. AUTO: automatic parsing.	MANUAL
OutputList	array<object>	The outputs of the file. This parameter corresponds to the "Schedule Configuration > Scheduling Dependencies > Output Name of Current Node" setting of a Data Studio task in the DataWorks console.
	object	The output information of the file.
RefTableName	string	The output table name of the file. This parameter corresponds to the "Output Table Name" in the "Schedule Configuration > Scheduling Dependencies > Output Name of Current Node" setting of a Data Studio task in the DataWorks console.	ods_user_info_d
Output	string	The output name of the file. This parameter corresponds to the "Output Name" in the "Schedule Configuration > Scheduling Dependencies > Output Name of Current Node" setting of a Data Studio task in the DataWorks console.	dw_project.002_out
DependentType	string	The method of depending on the previous cycle. Valid values: SELF: the dependency is set to the current node. CHILD: the dependency is set to first-level child nodes. USER_DEFINE: the dependency is set to other nodes. NONE: no dependency is selected, meaning the node does not depend on the previous cycle.	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 to which the table belongs. Valid values: DEV: development environment. PROD: production environment.	DEV
LifeCycle	integer	The lifecycle of the table. Unit: days.	7
TableName	string	The name of the table.	tb_hello
DataSourceName	string	The unique identifier of the data source to which the table belongs.	odps_source
Columns	array<object>	The list of columns.
	object	The column information.
ColumnName	string	The name of the column.	ID
ColumnType	string	The type of the column.	BIGINT
IsPartitionColumn	boolean	Indicates whether the column is a partition column. Valid values: true: The column is a partition column. false: The column is not a partition column.	false
Comment	string	The comment of the column.	ID
Comment	string	The comment of the table.	A new table
Location	string	The location information of the external 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.