Queries the information about node types, including the code and name of each node type.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetNodeTypeListInfo |
The operation that you want to perform. |
PageNumber | Integer | Yes | 1 |
The number of data pages that are requested. |
PageSize | Integer | Yes | 50 |
The size of the requested data page. Maximum value: 100. |
ProjectId | Long | Yes | 10000 |
Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information. |
RegionId | String | Yes | cn-zhangjiakou |
The list of regions where the services are located. |
ProjectIdentifier | String | No | dw_project |
Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page. You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call. |
Keyword | String | No | ODPS SQ |
The name of the node type. You can view the name of a node type in the directory tree of DataStudio. The name must be consistent with the locale. Fuzzy match is supported. All node types are returned. |
Locale | String | No | zh-CN |
Language screening, supporting zh-CN and en-US. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
NodeTypeInfoList | Struct |
The information of node types. |
|
NodeTypeInfo | Array of NodeTypeInfo |
Information about a single node type. |
|
NodeType | Integer | 10 |
The node Type (numeric Type). |
NodeTypeName | String | ODPS SQL |
The name of the node type. |
PageNumber | Integer | 1 |
The number of the page to return. |
PageSize | Integer | 50 |
The size of the current data page. |
TotalCount | Integer | 127 |
The total number of data records that meet the query conditions. |
RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the call. You can use the error ID to troubleshoot the error. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetNodeTypeListInfo &PageNumber=1 &PageSize=50 &ProjectId=10000 &RegionId=cn-zhangjiakou &<common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EFG****</RequestId> <NodeTypeInfoList> <TotalCount>127</TotalCount> <PageSize>50</PageSize> <PageNumber>1</PageNumber> <NodeTypeInfo> <NodeTypeName>ODPS SQL</NodeTypeName> <NodeType>10</NodeType> </NodeTypeInfo> </NodeTypeInfoList>
JSON
Format
{ "RequestId": "0000-ABCD-EFG****", "NodeTypeInfoList": { "TotalCount": 127, "PageSize": 50, "PageNumber": 1, "NodeTypeInfo": { "NodeTypeName": "ODPS SQL", "NodeType": 10 } } }
Error codes
HttpCode | Error codes | Error message | Description |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The request for the resource exceeds your available upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks the system is busy, please try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | Your request is too frequent, please try to slow down the request speed. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
Go to the Error CenterFor more information, see error codes.