Use the GetNodeChildren API to query descendant nodes - DataWorks - Alibaba Cloud - DataWorks

Calls GetNodeChildren to retrieve the downstream node list of a 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:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	The environment identifier of the Operation Center. PROD indicates the production environment. DEV indicates the development environment. Valid values: PROD : production environment. DEV : development environment.	PROD
NodeId	integer	Yes	The node ID. You can view the node ID in the Operation Center of the DataWorks console.	123456878

Response elements

Element	Type	Description	Example
	object	The response struct.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The unique ID of the request. You can use this ID to troubleshoot issues.	adsfasdf-adf-asdf-asdf-asdfadfasdd
ErrorMessage	string	The error message.	err
ErrorCode	string	The error code.	1060010000000
Success	boolean	Indicates whether the call was successful.	true
Data	object	The list of node information returned.
Nodes	array<object>	The list of nodes.
	object	The response struct.
SchedulerType	string	The scheduling type of the node. Valid values: NORMAL: The node is an auto triggered node. MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them. SKIP: The node is a dry-run node. 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
BaselineId	integer	The baseline ID.	12345656
Repeatability	boolean	Indicates whether the node can be rerun if the node fails to run. Valid values: true false	true
NodeName	string	The name of the node.	test_Node
ProjectId	integer	The ID of the workspace to which the node belongs.	12315412412
ProgramType	string	The type of the node.	ODPS_SQL
Priority	integer	The priority. Valid values: 1 to 8. A large value indicates a high priority.	3
OwnerId	string	The ID of the Alibaba Cloud account used by the node owner.	123124561341251321
CronExpress	string	The CRON expression. CRON expressions are used to run auto triggered nodes.	00 00 * * * *
NodeId	integer	The node ID.	1244564565
StepType	string	The scheduling dependency type. Valid values: 0: same-cycle scheduling dependency 3: cross-cycle scheduling dependency	0

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "adsfasdf-adf-asdf-asdf-asdfadfasdd",
  "ErrorMessage": "err",
  "ErrorCode": "1060010000000",
  "Success": true,
  "Data": {
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "BaselineId": 12345656,
        "Repeatability": true,
        "NodeName": "test_Node",
        "ProjectId": 12315412412,
        "ProgramType": "ODPS_SQL",
        "Priority": 3,
        "OwnerId": "123124561341251321",
        "CronExpress": "00 00 * * * * ",
        "NodeId": 1244564565,
        "StepType": "0"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.