ListFileType - - 阿里雲

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. Set the value to ListFileType.
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 workspace ID. You must configure either this parameter or the ProjectIdentifier parameter 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 workspace name. You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.
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.
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
RequestId	String	0000-ABCD-EFG****	The ID of the request. You can use the ID to troubleshoot issues.
NodeTypeInfoList	Object		The information of the node types.
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.
NodeTypeInfo	Array of NodeTypeInfo		The information of the node type.
NodeTypeName	String	ODPS SQL	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)
NodeType	Integer	10	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)

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListFileType
&ProjectId=10000
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=50
&Keyword=ODPS SQL
&Locale=zh-CN
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFileTypeResponse>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <NodeTypeInfoList>
        <PageNumber>1</PageNumber>
        <PageSize>50</PageSize>
        <TotalCount>127</TotalCount>
        <NodeTypeInfo>
            <NodeTypeName>ODPS SQL</NodeTypeName>
            <NodeType>10</NodeType>
        </NodeTypeInfo>
    </NodeTypeInfoList>
</ListFileTypeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
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.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.

For a list of error codes, see Service error codes.