Queries a list of files.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileFolderPath | string | No | The path to the folder where the file is located. | Business_process/my_first_business_process/MaxCompute/ods_layer |
| ProjectId | long | No | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied. | 10000 |
| Keyword | string | No | The keyword for the file name. Fuzzy match is supported. You can enter a keyword to query all files that contain the keyword. | ods |
| ProjectIdentifier | string | No | The DataWorks workspace name. To obtain the workspace name, log on to the DataWorks console and navigate to the workspace configuration page. You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call. | dw_project |
| PageNumber | integer | No | The page number for pagination. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
| UseType | string | No | The functional module to which the file belongs. Valid values:
| NORMAL |
| FileTypes | string | No | The code type of the file. The code type of the file. Common code types and their corresponding file types include: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (Combined node), 99 (Virtual node), 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 sync), 1002 (PAI internal node), 1089 (Cross-tenant node), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (Assignment node), 1106 (ForEach node), 1221 (PyODPS 3). | 10,23 |
| Owner | string | No | The ID of the file owner. | 3726346**** |
| NodeId | long | No | The ID of the scheduling node. You can call the ListNodes operation to obtain the node ID. | 123541234 |
| NeedContent | boolean | No | Specifies whether the query result includes the file content. For files with large content, network transmission delays may occur. | false |
| NeedAbsoluteFolderPath | boolean | No | Specifies whether the query result includes the path to the folder where the file is located. | false |
| ExactFileName | string | No | The exact file name. The file name in the query result must exactly match this parameter. | ods_create.sql |
| FileIdIn | string | No | The list of file IDs. The file IDs in the query result must be a subset of this list. You can specify up to 50 file IDs at a time. | 78237,816123 |
| LastEditUser | string | No | The Alibaba Cloud account ID of the user who last updated the file. | 11233*** |
| CommitStatus | integer | No | The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed). | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 13,
"Files": [
{
"CommitStatus": 1,
"AutoParsing": true,
"Owner": "3872572****",
"CreateTime": 1593950832000,
"FileType": 10,
"CurrentVersion": 2,
"BizId": 300000,
"LastEditUser": "382762****",
"FileName": "ods_user_info_d",
"ConnectionName": "odps_source",
"UseType": "NORMAL",
"FileFolderId": "2735c2****",
"FileId": 10000001,
"ParentId": -1,
"CreateUser": "382762****",
"IsMaxCompute": false,
"BusinessId": 300000,
"FileDescription": "my test datastudio file",
"LastEditTime": 1593950832000,
"Content": "SHOW TABLES;",
"NodeId": 300001,
"AbsoluteFolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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. | - |
| 500 | InternalError.System | An internal system error occurred. Try again later. | - |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | - |
For a list of error codes, visit the Service error codes.