All Products
Search
Document Center

DataWorks:ListNodeDependencies

Last Updated:Mar 14, 2025

Queries a list of descendant nodes of a node in DataStudio.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*list
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdstringYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.

10001
IdstringYes

The ID of the node.

860438872620113XXXX
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
PagingInfoobject

The pagination information.

TotalCountstring

The total number of entries returned.

90
PageSizestring

The number of entries per page.

10
PageNumberstring

The page number.

1
Nodesarray<object>

The descendant nodes.

nodeobject

The information about the descendant node.

Descriptionstring

The description of the node.

Node description
Namestring

The name of the node.

Node name
Idstring

The ID of the node.

723932906364267XXXX
ProjectIdstring

The ID of the workspace to which the node belongs.

65133
Ownerstring

The owner of the node.

110755000425XXXX
CreateTimelong

The time when the node was created. This value is a UNIX timestamp.

1724505917000
ModifyTimelong

The time when the node was last modified. This value is a UNIX timestamp.

1724505917000
DataSourceobject

The information about the data source.

Namestring

The name of the data source.

odps_first
Typestring

The type of the data source.

odps
TaskIdstring

The scheduling task ID.

580667964888595XXXX
Tagsarray<object>

The tags. This parameter is not in use.

tagobject

The tag. This parameter is not in use.

Keystring

The tag key.

null
Valuestring

The tag value.

null
Strategyobject

The scheduling policy.

Timeoutinteger

The timeout period. Unit: milliseconds.

0
InstanceModestring

The instance generation mode. Valid values:

  • T+1
  • Immediately
T+1
RerunModestring

The rerun mode. Valid values:

  • Allowed
  • Denied
  • FailureAllowed
Allowed
RerunTimesinteger

The number of reruns after a failure.

3
RerunIntervalinteger

The rerun interval after a failure. Unit: milliseconds.

180000
Outputsobject

The output of the node.

Variablesarray<object>

The variables.

variableobject

The variable.

Namestring

The name of the variable.

output
ArtifactTypestring

The artifact type.

Variable
Scopestring

The scope of the variable. Valid values:

  • NodeParameter
  • NodeContext
  • Workflow
  • Workspace
NodeParameter
Typestring

The type of the variable. Valid values:

  • NoKvVariableExpression
  • Constant
  • PassThrough
  • System
  • NodeOutput
Constant
Valuestring

The value of the variable.

111
Idstring

The variable ID.

543217824470354XXXX
Nodeobject

The node to which the variable belongs.

Outputstring

The output of the node to which the variable belongs.

463497880880954XXXX
NodeOutputsarray<object>

The node outputs.

nodeoutputobject

The node output.

Datastring

The node output.

463497880880954XXXX
Tablesarray<object>

The tables.

tableobject

The table.

Guidstring

The table ID.

odps.autotest.test_output_table_1
Inputsobject

The input of the node.

Variablesarray<object>

The variables.

variableobject

The variable.

Namestring

The name of the variable.

input
ArtifactTypestring

The artifact type.

Variable
Scopestring

The scope of the variable. Valid values:

  • NodeParameter
  • NodeContext
  • Workflow
  • Workspace
NodeParameter
Typestring

The type of the variable. Valid values:

  • NoKvVariableExpression
  • Constant
  • PassThrough
  • System
  • NodeOutput
Constant
Valuestring

The value of the variable.

111
Idstring

The variable ID.

543218872620113XXXX
Nodeobject

The node to which the variable belongs.

Outputstring

The output of the node.

860438872620113XXXX
NodeOutputsarray<object>

The node outputs.

nodeoutputobject

The node output.

Datastring

The node output.

860438872620113XXXX
Tablesarray<object>

The tables.

tableobject

The table.

Guidstring

The table ID.

odps.autotest.test_output_table_1
Triggerobject

The trigger.

Typestring

The type of the trigger.

Valid values:

  • Scheduler
  • Manual
  • Streaming
Scheduler
Idstring

The trigger ID.

543680677872062XXXX
Cronstring

The CRON expression for scheduling.

00 00 00 * * ?
StartTimestring

The start time of the validity period of the scheduling. The time is in the yyyy-MM-dd HH:mm:ss format.

1970-01-01 00:00:00
EndTimestring

The end time of the validity period of the scheduling. The time is in the yyyy-MM-dd HH:mm:ss format.

9999-01-01 00:00:00
Timezonestring

The time zone.

Asia/Shanghai
Scriptobject

The script information.

Pathstring

The script path.

root/demo
Runtimeobject

The runtime.

Commandstring

The command used to distinguish node types.

ODPS_SQL
Idstring

The script ID.

853573334108680XXXX
RuntimeResourceobject

The information about the resource group.

ResourceGroupIdstring

The resource group ID.

S_res_group_XXXX_XXXX
Recurrencestring

The scheduling type.

Valid values:

  • Normal: Nodes are scheduled as expected.
  • Pause: Nodes are paused, and the running of their descendant nodes is blocked.
  • Skip: Nodes are dry run. The system does not actually run the nodes but directly prompts that the nodes are successfully run. The running duration of the nodes is 0 seconds. In addition, the nodes do not occupy resources or block the running of their descendant nodes.
Normal

Examples

Sample success responses

JSONformat

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "PagingInfo": {
    "TotalCount": "90",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description",
        "Name": "Node name",
        "Id": "723932906364267XXXX",
        "ProjectId": "65133",
        "Owner": "110755000425XXXX",
        "CreateTime": 1724505917000,
        "ModifyTime": 1724505917000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": "580667964888595XXXX",
        "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",
              "Id": "543217824470354XXXX",
              "Node": {
                "Output": "463497880880954XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "463497880880954XXXX"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Id": "543218872620113XXXX",
              "Node": {
                "Output": "860438872620113XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX"
            }
          ],
          "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_res_group_XXXX_XXXX"
        },
        "Recurrence": "Normal"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-01-13The response structure of the API has changedView Change Details