ListNodes-阿里云帮助中心

Retrieves a paginated list of data development nodes that can be filtered by specified criteria.

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
ProjectId	integer	Yes	The ID of the DataWorks workspace. To find this ID, log in to the DataWorks console and navigate to the workspace configuration page.	12345
Scene	string	No	The context for filtering nodes. In data development, this corresponds to the sections in the directory tree on the left. If you omit this parameter, no filtering is applied. Valid values: DataworksProject: Nodes in the project directory. DataworksManualWorkflow: manual workflow DataworksManualTask: manual task	DataworksProject
ContainerId	string	No	The ID of the container. If you specify this parameter, only nodes in the specified container are returned. This parameter is independent of the resource group (ResourceGroupId). Important This parameter is of the Long type in SDK versions earlier than 8.0.0 and of the String type in SDK 8.0.0 and later. This change does not affect SDK usage. The parameter is returned in the type defined for your SDK version. The type change may cause compilation errors only when you upgrade the SDK across version 8.0.0. In this case, you must manually correct the data type.	860438872620113XXXX
Recurrence	string	No	Filters nodes by their scheduling type. Valid values: Normal: The node runs as scheduled. Pause: The node is paused and blocks its dependent downstream nodes. Skip: The node is skipped, and the system immediately returns a success status with a 0-second execution time. This action does not block downstream nodes or consume resources.	Normal
RerunMode	string	No	The rerun mode. Valid values: Allowed: The node can be rerun regardless of whether it succeeded or failed. FailureAllowed: The node can be rerun only if its previous run failed. Denied: The node cannot be rerun regardless of whether it succeeded or failed.	Allowed
Name	string	No	The node name. Fuzzy search is supported.	test
PageNumber	integer	No	The page number of the results to return.	1
PageSize	integer	No	The number of entries per page. Default: 10. Maximum: 100.	10

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo	object	The paging information.
TotalCount	string	The total number of entries that meet the specified filter criteria.	42
PageSize	string	The number of entries returned per page.	10
PageNumber	string	The page number of the returned data.	1
Nodes	array<object>	The list of nodes.
	array<object>	The details of a node.
Description	string	The description of the node.	Node description
Name	string	The name of the node.	test
ProjectId	integer	The ID of the DataWorks workspace. You can find this ID on the Workspace Management page in the DataWorks console.	33233
Owner	string	The owner of the node.	110755000425XXXX
CreateTime	integer	The creation timestamp of the node.	1722910655000
ModifyTime	integer	The last modification timestamp of the node.	1722910655000
DataSource	object	The data source.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
TaskId	integer	The ID of the scheduling task.	88888888888
Tags	array<object>	The tags for the node. This parameter is not in use.
	object	A single tag. This parameter is not in use.
Key	string	The tag key.	null
Value	string	The tag value.	null
Strategy	object	The scheduling strategy.
Timeout	integer	The timeout duration.	0
InstanceMode	string	The instance generation mode. `T+1` `Immediately`	T+1
RerunMode	string	The rerun mode. `Allowed` `Denied` `FailureAllowed`	Allowed
RerunTimes	integer	The number of retries.	3
RerunInterval	integer	The retry interval, in milliseconds.	180000
Outputs	object	The node outputs.
Variables	array<object>	The list of variables.
	array<object>	The details of a variable.
Name	string	The name of the variable.	output
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the variable. `NodeParameter` `NodeContext` `Workflow` `Workspace`	NodeParameter
Type	string	The type of the variable. `NoKvVariableExpression` `Constant` `PassThrough` `System` `NodeOutput`	Constant
Value	string	The value of the variable.	111
Node	object	The node to which the variable belongs.
Output	string	The node output.	860438872620113XXXX
Id	string	The variable ID. Important This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK. Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.	623731286945488XXXX
NodeOutputs	array<object>	The list of node outputs.
	object	A node output item.
Data	string	The node output.	860438872620113XXXX
RefTableName	string	A human-readable name for the output data table. This name is for display purposes only and has no functional effect.	testProject.testTableName
Tables	array<object>	The list of tables.
	object	A table output item.
Guid	string	The ID of the table.	odps.autotest.test_output_table_1
Inputs	object	The node inputs.
Variables	array<object>	The list of variables.
	array<object>	The details of a variable.
Name	string	The name of the variable.	input
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the variable. `WorkSpace` `NodeParameter` `NodeContext` `Workflow`	NodeParameter
Type	string	The type of the variable. `NoKvVariableExpression` `Constant` `PassThrough` `System` `NodeOutput`	Constant
Value	string	The value of the variable.	222
Node	object	The node to which the variable belongs.
Output	string	The node output.	623731286945488XXXX
Id	string	The variable ID. Important This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK. Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.	543211286945488XXXX
NodeOutputs	array<object>	The list of node outputs.
	object	A node output item.
Data	string	The node output.	623731286945488XXXX
RefTableName	string	A human-readable name for the input data table. This name is for display purposes only and has no functional effect.	testProject.testTableName
Tables	array<object>	The list of tables.
	object	A table output item.
Guid	string	The ID of the table.	odps.autotest.test_output_table_1
Trigger	object	The trigger.
Type	string	The type of the trigger. Valid values: `Scheduler`: periodic scheduling `Manual`: manual trigger `Streaming`: streaming task	Scheduler
Cron	string	The cron expression.	00 00 00 * * ?
StartTime	string	The start of the trigger's validity period.	1970-01-01 00:00:00
EndTime	string	The end of the trigger's validity period.	9999-01-01 00:00:00
Timezone	string	The time zone.	Asia/Shanghai
Id	string	The ID of the trigger. Important This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK. Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.	543680677872062XXXX
Script	object	Information about the script.
Path	string	The path of the script.	root/demo
Runtime	object	The runtime.
Command	string	The command that identifies the node type.	ODPS_SQL
Id	string	The ID of the script. Important This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK. Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.	853573334108680XXXX
RuntimeResource	object	Information about the resource group.
ResourceGroupId	string	The ID of the resource group.	123456XXX
ResourceGroup	string	The identifier of the resource group. You can obtain this identifier by calling the ListResourceGroups operation.	S_res_group_XXXX
Recurrence	string	The scheduling type. Valid values: `Normal`: The node runs as scheduled. `Pause`: The node is paused and blocks the execution of its downstream nodes. `Skip`: The node is skipped. The system immediately returns a success status with an execution duration of 0 seconds. This does not block downstream nodes or consume resources.	Normal
Id	string	The unique identifier of the data development node. Important This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK. Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.	860438872620113XXXX

Examples

Success response

JSON format

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description\n",
        "Name": "test",
        "ProjectId": 33233,
        "Owner": "110755000425XXXX",
        "CreateTime": 1722910655000,
        "ModifyTime": 1722910655000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 88888888888,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output\n",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "623731286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Node": {
                "Output": "623731286945488XXXX"
              },
              "Id": "543211286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai",
          "Id": "543680677872062XXXX"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "123456XXX",
          "ResourceGroup": "S_res_group_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "860438872620113XXXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.