Queries the information about node types, including the code and name of a node type.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
No |
The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and query the ID. |
10000 |
| ProjectIdentifier |
string |
No |
The unique identifier of the DataWorks workspace. You can view the identifier in the upper part of the DataStudio page. You can also select another identifier to switch to another workspace. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied. |
dw_project |
| PageNumber |
integer |
Yes |
The page number. |
1 |
| PageSize |
integer |
Yes |
The number of entries per page. Maximum value: 100. |
50 |
| Keyword |
string |
No |
The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. You can view the English or Chinese name of a specific node type, but the language specified to present the name must be the same as the language specified by the Locale parameter. Fuzzy match is supported. If this parameter is not configured, the names of all node types are returned. |
ODPS SQ |
| Locale |
string |
No |
The language that you use for the query. Valid values: zh-CN and en-US. |
zh-CN |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0000-ABCD-EFG**** |
| NodeTypeInfoList |
object |
The list of node types. |
|
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
50 |
| TotalCount |
integer |
The total number of entries returned. |
127 |
| NodeTypeInfo |
array<object> |
The information about a node type. |
|
|
object |
|||
| NodeTypeName |
string |
The name of the node type. |
ODPS SQL |
| NodeType |
integer |
The type of the node, which is specified by a number. |
10 |
Examples
Success response
JSON format
{
"RequestId": "0000-ABCD-EFG****",
"NodeTypeInfoList": {
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 127,
"NodeTypeInfo": [
{
"NodeTypeName": "ODPS SQL",
"NodeType": 10
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.