ListFileType

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 view the ID on the Workspace page in the DataWorks console. Either this parameter or ProjectIdentifier is required.	10000
ProjectIdentifier	string	No	The DataWorks workspace name. You can view the name on the Workspace page in the DataWorks console. Either this parameter or ProjectId is required.	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 node type name. View available node types on the DataStudio page in the DataWorks console. The language must match the Locale parameter. Fuzzy match is supported. If not specified, all node types are returned.	ODPS SQL
Locale	string	No	The query language. 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 node type information.
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 node type details.
	object
NodeTypeName	string	The node type name. Code-to-name 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 node type code. Code-to-name 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.