Retrieve Node Descendant Dependencies via ListNodeDependencies - DataWorks - Alibaba Cloud - DataWorks

Gets a paginated list of dependent nodes for a specified data development 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:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can go to the Workspace Management page in the DataWorks console to obtain the workspace ID. This parameter is used to specify the DataWorks workspace for the API call.	10001
Id	string	Yes	The ID of the node. Important The data type of this parameter is Long in SDKs earlier than V8.0.0, and is String in SDKs of V8.0.0 and later versions. The change does not affect the normal use of the SDKs. The parameter is still returned as the type defined in the SDKs. When you upgrade an SDK to a version later than V8.0.0, a compilation error may occur due to the type change. In this case, you must manually change the data type.	860438872620113XXXX
PageNumber	integer	No	The number of the page to return. The value of this parameter must be a positive integer. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID. Use this ID to locate logs and troubleshoot issues.	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
PagingInfo	object	The pagination settings.
TotalCount	string	The total number of matching entries.	90
PageSize	string	The number of entries to return on each page.	10
PageNumber	string	The number of the page to return.	1
Nodes	array<object>	A list of dependent nodes.
	array<object>	Details of a dependent node.
Description	string	The description of the node.	Node description
Name	string	The name of the data development node.	Node name
ProjectId	integer	The ID of the project that contains the node.	65133
Owner	string	The owner of the data development node.	110755000425XXXX
CreateTime	integer	The creation timestamp of the data development node.	1724505917000
ModifyTime	integer	The last modification timestamp of the data development node.	1724505917000
DataSource	object	The data source.
Name	string	The data source name.	odps_first
Type	string	The data source type.	odps
TaskId	integer	The ID of the scheduling task.	580667964888595XXXX
Tags	array<object>	A list of tags. This parameter is currently not in use.
	object	A single tag. This parameter is currently not in use.
Key	string	The tag key.	null
Value	string	The tag value.	null
Strategy	object	The scheduling strategy.
Timeout	integer	The timeout period, in milliseconds.	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 after a failure.	3
RerunInterval	integer	The retry interval after a failure, in milliseconds.	180000
Outputs	object	Details about the node's outputs.
Variables	array<object>	A list of variables.
	array<object>	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 that corresponds to the variable.	463497880880954XXXX
Id	string	The ID of the variable. Important The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. This change does not affect normal usage, as the parameter's data type matches the SDK definition. However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.	543217824470354XXXX
NodeOutputs	array<object>	A list of node outputs.
	object	A node output item.
Data	string	The node output.	463497880880954XXXX
RefTableName	string	A human-readable name for the node's target data table. This identifier is for display purposes only and does not enforce logical constraints.	testProject.testTableName
Tables	array<object>	A list of tables.
	object	A table output item.
Guid	string	The ID of the table.	odps.autotest.test_output_table_1
Inputs	object	Details about the node's inputs.
Variables	array<object>	A list of variables.
	array<object>	A variable.
Name	string	The name of the variable.	input
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 ID of the variable. Important The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. This change does not affect normal usage, as the parameter's data type matches the SDK definition. However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.	543218872620113XXXX
NodeOutputs	array<object>	A list of node outputs.
	object	A node output item.
Data	string	The node output.	860438872620113XXXX
RefTableName	string	A human-readable name for the node's target data table. This identifier is for display purposes only and does not enforce logical constraints.	testProject.testTableName
Tables	array<object>	A 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 trigger type. Valid values: `Scheduler`: Periodic scheduling. `Manual`: Manual scheduling. `Streaming`: Stream-based scheduling.	Scheduler
Cron	string	The cron expression used for scheduling.	00 00 00 * * ?
StartTime	string	The time when scheduling becomes effective, in `yyyy-MM-dd HH:mm:ss` format.	1970-01-01 00:00:00
EndTime	string	The time when scheduling expires, in `yyyy-MM-dd HH:mm:ss` format.	9999-01-01 00:00:00
Timezone	string	The time zone.	Asia/Shanghai
Id	string	The unique ID of the trigger. Important The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. This change does not affect normal usage, as the parameter's data type matches the SDK definition. However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.	543680677872062XXXX
Script	object	Details about the script.
Path	string	The path of the script.	root/demo
Runtime	object	The runtime environment.
Command	string	The command that is used to distinguish between node types.	ODPS_SQL
Id	string	The ID of the script. Important The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. This change does not affect normal usage, as the parameter's data type matches the SDK definition. However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.	853573334108680XXXX
RuntimeResource	object	Details about the resource group.
ResourceGroupId	string	The ID of the resource group.	S_res_group_XXXX_XXXX
Recurrence	string	The execution mode of the node. Valid values: `Normal`: The node runs as normal. `Pause`: The node is paused. This action blocks the execution of downstream nodes that depend on this node. `Skip`: The node is skipped (dry run). The system immediately returns a success status with an execution time of 0 seconds. This action does not block downstream nodes or consume resources.	Normal
Id	string	The unique ID of the data development node. Important The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. This change does not affect normal usage, as the parameter's data type matches the SDK definition. However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.	723932906364267XXXX

Examples

Success response

JSON format

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "PagingInfo": {
    "TotalCount": "90",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description",
        "Name": "Node name",
        "ProjectId": 65133,
        "Owner": "110755000425XXXX",
        "CreateTime": 1724505917000,
        "ModifyTime": 1724505917000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 0,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "463497880880954XXXX"
              },
              "Id": "543217824470354XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "463497880880954XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "543218872620113XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "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": "S_res_group_XXXX_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "723932906364267XXXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.