Call the GetNode API to get node details - DataWorks - Alibaba Cloud - DataWorks

Indicates whether the request is successful.

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
NodeId	integer	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 elements

Element	Type	Description	Example
	object	The response parameters.
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	integer	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	integer	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_source_dev
ParamValues	string	The CRON expression returned.	a=b
RelatedFlowId	integer	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	integer	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.	SQL node
ResGroupName	string	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	Default Resource Group
BusinessId	integer	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	integer	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	integer	The file ID. Warning** The field is deprecated.	123
FileVersion	integer	The version of the file.	1
DeployDate	integer	The deployment date.	1727280000000
CreateTime	integer	The creation time.	1727280000000
ModifyTime	integer	The modification time.	1727280000000

Examples

Success response

JSON format

{
  "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_source_dev",
    "ParamValues": "a=b",
    "RelatedFlowId": 123,
    "DqcType": 1,
    "BaselineId": 123456,
    "Description": "test",
    "NodeName": "SQL node",
    "ResGroupName": "Default Resource Group",
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.