ListFileType

Queries the information about node types, such as the code and name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to view the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to view the workspace name. 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 Data Studio 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 configure this parameter: You can view the Chinese or English 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 configured, the names of all node types are returned.	ODPS SQL
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 information about node types.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	50
TotalCount	integer	The total number of entries that meet the query conditions.	127
NodeTypeInfo	array<object>	The information about the node type.
	object
NodeTypeName	string	The name of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)	ODPS SQL
NodeType	integer	The code of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)	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.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.System	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.