Queries a list of descendant nodes of a node in DataStudio.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | list | *All Resources * |
| none |
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. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied. | 10001 |
| Id | string | Yes | The unique identifier of the Data Studio node. Note
Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.
| 860438872620113XXXX |
| PageNumber | integer | No | The page number, starting from 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2025-01-13 | The response structure of the API has changed | View Change Details |