ListNodes API reference for querying nodes - DataWorks - Alibaba Cloud - DataWorks

The ID of the workspace.

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:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Owner	string	No	The description of the node.	193379****
BizName	string	No	The error code returned.	test_bizName
ProgramType	string	No	The operation that you want to perform. Set the value to ListNodes.	ODPS_SQL
PageNumber	integer	No	The page number. Minimum value: 1. Maximum value: 100.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ProjectId	integer	Yes	The ID of the owner.	1234
ProjectEnv	string	Yes	The environment in which the node runs. Valid values: DEV and PROD.	PROD
NodeName	string	No	The ID of the baseline with which the node is associated.	liux_test_n****
SchedulerType	string	No	The scheduling type. Valid values: NORMAL: Nodes are scheduled as expected. PAUSE: Nodes are paused. SKIP: Nodes are dry-run. 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

Response elements

Element	Type	Description	Example
	object	The returned result.
HttpStatusCode	integer	The interval at which the node is rerun after the node fails to run.	200
RequestId	string	The list of nodes.	E6F0DBDD-5AD****
ErrorMessage	string	The page number of the returned page.	The connection does not exist.
ErrorCode	string	The HTTP status code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the node can be rerun.	true
Data	object	The nodes.
PageNumber	integer	The name of the node.	1
PageSize	integer	The cron expression returned.	10
TotalCount	integer	The name of the workflow.	66
Nodes	array<object>	The information about the nodes.
	object	The returned result.
SchedulerType	string	The types of the nodes. You can call the ListNodes operation to query the type of the node.	NORMAL
RepeatInterval	integer	The environment of the workspace. Valid values: PROD and DEV.	60
Repeatability	boolean	The name of the node.	true
RepeatMode	integer	The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.	1
ProjectId	integer	The information about the nodes.	33671
ProgramType	string	The error message returned.	ODPS_SQL
Priority	integer	The ID of the owner.	1
OwnerId	string	The additional parameters.	19337906836551
Connection	string	The name of the resource group.	odps_source
ParamValues	string	The type of the node.	a=b
RelatedFlowId	integer	The table and partition filter expression in Data Quality that are associated with the node.	1231123
DqcType	integer	The connection string.	1
BaselineId	integer	The number of the page to return. Minimum value: 1. Maximum value: 100.	123456
Description	string	The priority for running the node. Valid values: 1, 3, 5, 7, and 8.	test
NodeName	string	The total number of nodes returned.	liux_test_n****
ResGroupName	string	The ID of the workflow.	Default Resource Group
BusinessId	integer	The operation that you want to perform. Set the value to ListNodes.	123
DqcDescription	string	The ID of the owner.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpress	string	The name of the workflow.	00 00 00 * * ?
NodeId	integer	The types of the nodes. You can call the ListNodes operation to query the type of the node.	1234
ResGroupIdentifier	string	The identifier of the resource group.	group_123
FileType	integer	Different file types have different codes. For more information, see DataWorks node collection. You can also call the ListFileType interface to query the code type of the file.	10
FileId	integer	The file ID. You can call the ListFiles operation to query the ID. Warning** This field is deprecated.	20
FileVersion	integer	The latest version number of the file.	3
DeployDate	integer	The timestamp when the node was deployed. Unit: milliseconds.	1734537600000
CreateTime	integer	The timestamp when the node was created. Unit: milliseconds.	1593879116000
ModifyTime	integer	The timestamp when the node was modified. Unit: milliseconds.	1593879116000

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "RepeatInterval": 60,
        "Repeatability": true,
        "RepeatMode": 1,
        "ProjectId": 33671,
        "ProgramType": "ODPS_SQL",
        "Priority": 1,
        "OwnerId": "19337906836551",
        "Connection": "odps_source",
        "ParamValues": "a=b",
        "RelatedFlowId": 1231123,
        "DqcType": 1,
        "BaselineId": 123456,
        "Description": "test",
        "NodeName": "liux_test_n****",
        "ResGroupName": "Default Resource Group",
        "BusinessId": 123,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "CronExpress": "00 00 00 * * ?",
        "NodeId": 1234,
        "ResGroupIdentifier": "group_123",
        "FileType": 10,
        "FileId": 20,
        "FileVersion": 3,
        "DeployDate": 1734537600000,
        "CreateTime": 1593879116000,
        "ModifyTime": 1593879116000
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.