Queries a list of nodes in DataStudio. You can also specify filter conditions to query specific nodes.
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. | 12345 |
| Scene | string | No | The location of the nodes in the left-side navigation pane of the Data Studio page, which is a filter condition. If you do not want to use this condition for filtering, you do not need to configure this parameter. Valid values:
| DATAWORKS_PROJECT |
| ContainerId | string | No | Leave this parameter empty if not specified. Filter condition: within a specified container. Specify the container ID. This parameter is independent of the resource group ID (ResourceGroupId). 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 |
| Recurrence | string | No | Leave this parameter empty if not specified. Filter condition: within a specified container. Specify the container ID. This parameter is independent of the resource group ID (ResourceGroupId). 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.
| Normal |
| RerunMode | string | No | The rerun property, which is a filter condition. If you do not want to use this condition for filtering, you do not need to configure this parameter. Valid values:
| Allowed |
| Name | string | No | The name of the node. Fuzzy search is supported. | test |
| PageNumber | integer | No | The page number of the data to retrieve, used for pagination. | 1 |
| PageSize | integer | No | The page number of the data to retrieve, used for pagination. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
"PagingInfo": {
"TotalCount": 42,
"PageSize": 10,
"PageNumber": 1,
"Nodes": [
{
"Description": "Node description\n",
"Name": "test",
"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,
"Node": {
"Output": "860438872620113XXXX"
},
"Id": "623731286945488XXXX"
}
],
"NodeOutputs": [
{
"Data": "860438872620113XXXX"
}
],
"Tables": [
{
"Guid": "odps.autotest.test_output_table_1"
}
]
},
"Inputs": {
"Variables": [
{
"Name": "input",
"ArtifactType": "Variable",
"Scope": "NodeParameter",
"Type": "Constant",
"Value": 222,
"Node": {
"Output": "623731286945488XXXX"
},
"Id": "543211286945488XXXX"
}
],
"NodeOutputs": [
{
"Data": "623731286945488XXXX"
}
],
"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_resgrop_xxx",
"ResourceGroup": "S_res_group_XXXX"
},
"Recurrence": "Normal",
"Id": "860438872620113XXXX"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-12-29 | The response structure of the API has changed | View Change Details |
| 2025-04-02 | The response structure of the API has changed | View Change Details |
| 2025-01-13 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-01-13 | The response structure of the API has changed | View Change Details |
| 2024-10-11 | The request parameters of the API has changed | View Change Details |