ListNodes - DataWorks - Alibaba Cloud Documentation Center

Queries a list of nodes in DataStudio. You can also specify filter conditions to query specific nodes.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	12345
Scene	string	No	The scene of nodes. This parameter specifies a filter condition. Valid values: DATAWORKS_PROJECT MANUAL_WORKFLOW MANUAL_NODE Enumeration Value: DataworksManualTask: DataworksManualTask. DataworksProject: DataworksProject. DataworksManualWorkflow: DataworksManualWorkflow.	DATAWORKS_PROJECT
ContainerId	string	No	The container ID. This parameter specifies a filter condition.	860438872620113XXXX
RerunMode	string	No	The rerun mode. Valid values: Allowed: The nodes can be rerun regardless of whether they are successfully run or fail to run. FailureAllowed: The nodes can be rerun only after they fail to run. Denied: The nodes cannot be rerun regardless of whether they are successfully run or fail to run.	Allowed
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo	object	The pagination information.
TotalCount	string	The total number of entries returned.	42
PageSize	string	The number of entries per page.	10
PageNumber	string	The page number.	1
Nodes	array<object>	The nodes.
node	object	The information about a node.
Description	string	The description of the node.
Name	string	The name of the node.	test
Id	string	The ID of the node.	860438872620113XXXX
ProjectId	string	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	33233
Owner	string	The owner of the node.	110755000425XXXX
CreateTime	long	The time when the node was created. This value is a UNIX timestamp.	1722910655000
ModifyTime	long	The time when the node was last modified. This value is a UNIX timestamp.	1722910655000
DataSource	object	The information about the data source.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
TaskId	string	The scheduling task ID.	88888888888
Tags	array<object>	The tags. This parameter is not in use.
tag	object	The tag. This parameter is not in use.
Key	string	The tag key.	null
Value	string	The tag value.	null
Strategy	object	The scheduling policy.
Timeout	integer	The timeout period.	0
InstanceMode	string	The instance generation mode.	T+1
RerunMode	string	The rerun mode.	Allowed
RerunTimes	integer	The number of reruns.	3
RerunInterval	integer	The rerun interval. Unit: milliseconds.	180000
Outputs	object	The output of the node.
Variables	array<object>	The variables.
variable	object	The variable.
Name	string	The name of the variable.	output
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the variable. Valid values: NodeParameter NodeContext Workflow Workspace	NodeParameter
Type	string	The type of the variable. Valid values: NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	The value of the variable.	111
Id	string	The variable ID.	623731286945488XXXX
Node	object	The node to which the variable belongs.
Output	string	The output of the node.	860438872620113XXXX
NodeOutputs	array<object>	The node outputs.
nodeoutput	object	The node output.
Data	string	The node output.	860438872620113XXXX
Tables	array<object>	The tables.
table	object	The table.
Guid	string	The table ID.	odps.autotest.test_output_table_1
Inputs	object	The input of the node.
Variables	array<object>	The variables.
variable	object	The variable.
Name	string	The name of the variable.	input
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the variable. Valid values: WorkSpace NodeParameter NodeContext Workflow	NodeParameter
Type	string	The type of the variable. Valid values: NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	The value of the variable.	222
Id	string	The variable ID.	543211286945488XXXX
Node	object	The node to which the variable belongs.
Output	string	The output of the node.	623731286945488XXXX
NodeOutputs	array<object>	The node outputs.
nodeoutput	object	The node output.
Data	string	The node output.	623731286945488XXXX
Tables	array<object>	The tables.
table	object	The table outputs.
Guid	string	The table ID.	odps.autotest.test_output_table_1
Trigger	object	The trigger.
Type	string	The type of the trigger. Valid values: Scheduler Manual Steaming Enumeration Value: Streaming: Streaming. Scheduler: Scheduler. Manual: Manual.	Scheduler
Id	string	The trigger ID.	543680677872062XXXX
Cron	string	The CRON expression for scheduling.	00 00 00 * * ?
StartTime	string	The start time of the validity period of the trigger.	1970-01-01 00:00:00
EndTime	string	The end time of the validity period of the trigger.	9999-01-01 00:00:00
Timezone	string	The time zone.	Asia/Shanghai
Script	object	The script information.
Path	string	The script path.	root/demo
Runtime	object	The runtime.
Command	string	The command used to distinguish node types.	ODPS_SQL
Id	string	The script ID.	853573334108680XXXX
RuntimeResource	object	The information about the resource group.
ResourceGroupId	string	The resource group ID.	S_resgrop_xxx
Recurrence	string	The scheduling type. Valid values: Normal: The node is scheduled as expected. Pause: The node is paused, and the running of its descendant nodes is blocked. Skip: The node is dry run. The system does not actually run the node but directly prompts that the node is successfully run. The running duration of the node is 0 seconds. In addition, the node does not occupy resources or block the running of its descendant nodes.	Normal

Examples

Sample success responses

JSONformat

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "",
        "Name": "test",
        "Id": "860438872620113XXXX",
        "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",
              "Id": "623731286945488XXXX",
              "Node": {
                "Output": "860438872620113XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Id": "543211286945488XXXX",
              "Node": {
                "Output": "623731286945488XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Id": "543680677872062XXXX",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        },
        "Recurrence": "Normal"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-10-11	The request parameters of the API has changed	View Change Details