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

Retrieves the details of a node.

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 ID of the node. You can call the ListNodes operation to query the node ID.	1234
ProjectEnv	string	Yes	The environment of the workspace. Valid values: PROD and DEV. Valid values: PROD : Production environment. DEV : Development environment.	PROD

Response elements

Element	Type	Description	Example
	object	The response entity.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	E6F0DBDD-5AD****
ErrorMessage	string	The error message.	The connection does not exist.
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the node.
SchedulerType	string	The scheduling type. Valid values: NORMAL: normal scheduling node. MANUAL: manual node that is not scheduled on a regular basis. PAUSE: paused node. SKIP: dry-run node that is scheduled on a regular basis but is directly set to successful when scheduling starts.	NORMAL
RepeatInterval	integer	The interval at which the node is rescheduled after a failure.	60
Repeatability	string	Indicates whether the node can be rerun.	true
RepeatMode	integer	The rerun mode. A value of 0 indicates that the node can be rerun only upon failure. A value of 1 indicates that the node can be rerun in all cases. A value of 2 indicates that the node cannot be rerun in any case.	1
ProjectId	integer	The ID of the workspace.	1234
ProgramType	string	The type of the node.	ODPS_SQL
Priority	integer	The priority of the node. Valid values: 1, 3, 5, 7, and 8.	1
OwnerId	string	The ID of the node owner.	17366294****
Connection	string	The connection string.	odps_source_dev
ParamValues	string	The additional parameters.	a=b
RelatedFlowId	integer	The ID of the associated workflow.	123
DqcType	integer	The DQC type. A value of 0 indicates that no DQC rule is associated. A value of 1 indicates that a DQC rule is associated.	1
BaselineId	integer	The baseline ID. The baseline ID configured for the node as a leaf node is returned. If no baseline is configured, a workspace default value is returned.	123456
Description	string	The description of the node.	test
NodeName	string	The name of the node.	sql_node
ResGroupName	string	The name of the resource group.	Default Resource Group
BusinessId	integer	The ID of the workflow.	123
DqcDescription	string	The DQC partitioning rule string.	[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]
CronExpress	string	The CRON expression.	00 00 00 * * ?
NodeId	integer	The ID of the node.	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 nodes.	10
FileId	integer	The file ID. Warning This field is deprecated.	123
FileVersion	integer	The file version.	1
DeployDate	integer	The deployment date. The value is a 13-digit number, such as `1727280000000`.	1727280000000
CreateTime	integer	The creation time. The value is a 13-digit number, such as `1727280000000`.	1727280000000
ModifyTime	integer	The modification time. The value is a 13-digit number, such as `1727280000000`.	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.