GetNode - DataWorks - Alibaba Cloud Documentation Center

Indicates whether the request is successful.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
NodeId	long	Yes	The interval at which the node is rerun after the node fails to run.	1234
ProjectEnv	string	Yes	The environment of the workspace. Valid values: PROD and DEV.	PROD

Response parameters

Parameter	Type	Description	Example
	object	The error code returned.
HttpStatusCode	integer	The operation that you want to perform. Set the value to GetNode.	200
RequestId	string	Other parameters.	E6F0DBDD-5AD****
ErrorMessage	string	The connection string.	The connection does not exist.
ErrorCode	string	The ID of the node. You can call the ListNodes operation to query the node ID.	Invalid.Tenant.ConnectionNotExists
Success	boolean	The ID of the workflow.	true
Data	object	The details of the node.
SchedulerType	string	The ID of the workspace.	NORMAL
RepeatInterval	long	The ID of the workflow to which the node belongs.	60
Repeatability	string	The type of the node.	true
RepeatMode	integer	Rerun mode. 0 indicates that you can rerun only if you fail, 1 indicates that you can rerun in all cases, and 2 indicates that you cannot rerun in all cases.	1
ProjectId	long	Indicates whether the node can be rerun.	1234
ProgramType	string	The ID of the owner of the node.	ODPS_SQL
Priority	integer	The HTTP status code returned.	1
OwnerId	string	The ID of the node.	17366294****
Connection	string	The environment of the workspace. Valid values: PROD and DEV.	odps_first_dev
ParamValues	string	The CRON expression returned.	a=b
RelatedFlowId	long	Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. A value of 0 indicates that the node is associated with Data Quality. A value of 1 indicates that the node is not associated with Data Quality.	123
DqcType	integer	The error message returned.	1
BaselineId	long	The description of the node.	123456
Description	string	The name of the resource group.	test
NodeName	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. 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.	The ID of the baseline.
ResGroupName	string	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	The table and partition filter expression in Data Quality that are associated with the node.
BusinessId	long	The operation that you want to perform. Set the value to GetNode.	123
DqcDescription	string	The ID of the node. You can call the ListNodes operation to query the node ID.	[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]
CronExpress	string	The environment of the workspace. Valid values: PROD and DEV.	00 00 00 * * ?
NodeId	long	The HTTP status code returned.	1234
ResGroupIdentifier	string	The unique identifier of the resource group.	group_123
FileType	integer	The file type. Different file types have different codes. For more information, see DataWorks node collection.	10
FileId	long	The ID of the file.	123
FileVersion	integer	The version of the file.	1
DeployDate	long	The deployment date.	1727280000000
CreateTime	long	The creation time.	1727280000000
ModifyTime	long	The modification time.	1727280000000

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "SchedulerType": "NORMAL",
    "RepeatInterval": 60,
    "Repeatability": "true",
    "RepeatMode": 1,
    "ProjectId": 1234,
    "ProgramType": "ODPS_SQL",
    "Priority": 1,
    "OwnerId": "17366294****",
    "Connection": "odps_first_dev",
    "ParamValues": "a=b",
    "RelatedFlowId": 123,
    "DqcType": 1,
    "BaselineId": 123456,
    "Description": "test",
    "NodeName": "The ID of the baseline.\n",
    "ResGroupName": "The table and partition filter expression in Data Quality that are associated with the node.\n",
    "BusinessId": 123,
    "DqcDescription": "[{\"projectName\":\"test_0923001\",\"tableName\":\"test_table_001\",\"partition\":\"ds\\u003d$[yyyymmdd]\"},{\"projectName\":\"test_0923001\",\"tableName\":\"test_table_002\",\"partition\":\"NOTAPARTITIONTABLE\"}]",
    "CronExpress": "00 00 00 * * ?",
    "NodeId": 1234,
    "ResGroupIdentifier": "group_123",
    "FileType": 10,
    "FileId": 123,
    "FileVersion": 1,
    "DeployDate": 1727280000000,
    "CreateTime": 1727280000000,
    "ModifyTime": 1727280000000
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-26	The response structure of the API has changed	View Change Details
2024-05-30	The response structure of the API has changed	View Change Details
2023-06-05	The internal configuration of the API is changed, but the call is not affected	View Change Details