Queries the information of one or more node types, such as the code and name of a node type.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFileType

The operation that you want to perform.

PageNumber Integer Yes 1

The number of the page to return.

PageSize Integer Yes 50

The number of entries to return on each page. Maximum value: 100.

RegionId String Yes cn-zhangjiakou

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

ProjectId Long No 10000

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.

ProjectIdentifier String No dw_project

The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the name.

You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.

Keyword String No ODPS SQL

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. Take note of the following items when you use this parameter:

  • You can view the English or Chinese name of a specific node type, but the language specified by this parameter 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 specified, the names of all node types are returned.
Locale String No zh-CN

The language that you use for the query. Valid values: zh-CN and en-US.

Response parameters

Parameter Type Example Description
NodeTypeInfoList Struct

The information of the node types.

NodeTypeInfo Array of NodeTypeInfo

The information of the node type.

NodeType Integer 10

The code of the node type.

The codes and names of node types have the following mappings:

6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero-load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time synchronization node), 1089 (cross-tenant collaboration node node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).

NodeTypeName String ODPS SQL

The name of the node type.

The codes and names of node types have the following mappings:

6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero-load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time synchronization node), 1089 (cross-tenant collaboration node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 50

The number of entries returned per page.

TotalCount Integer 127

The total number of entries returned.

RequestId String 0000-ABCD-EFG****

The ID of the request. You can use the ID to troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListFileType
&PageNumber=1
&PageSize=50
&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

Http status code Error code Error message Description
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not authorized to perform this operation. Activate DataWorks Enterprise Edition or Ultimate Edition.

For a list of error codes, visit the API Error Center.