ListFiles-DataWorks(DataWorks)-阿里云帮助中心

Queries a list of files by calling ListFiles.

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
FileFolderPath	string	No	The path of the folder where the file is stored.	Business_process/my_first_business_process/MaxCompute/ods_layer
ProjectId	integer	No	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. You must specify either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace for this API call.	10000
Keyword	string	No	The keyword of the file name. Fuzzy match is supported. You can enter a keyword to query all files whose names contain the keyword.	ods
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace name. You must specify either this parameter or the ProjectId parameter to determine the 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: DataStudio. MANUAL: manual node. MANUAL_BIZ: manual workflow. SKIP: dry-run scheduling in DataStudio. ADHOCQUERY: ad hoc query. COMPONENT: component management.	NORMAL
FileTypes	string	No	The code type of the file. Common codes 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 check), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 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 owner of the file.	3726346****
NodeId	integer	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 latency may be significant.	false
NeedAbsoluteFolderPath	boolean	No	Specifies whether the query result includes the path of the folder where the file is stored.	false
ExactFileName	string	No	The file name for exact match. The file name in the query result exactly matches this parameter value.	ods_create.sql
FileIdIn	string	No	The list of file IDs. The file IDs in the query result can only be a subset of this list. A maximum of 50 file IDs can be specified at a time.	78237,816123
LastEditUser	string	No	The Alibaba Cloud 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 has not been committed) and 1 (the latest code has been committed).	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	0000-ABCD-****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Data	object	The returned data details.
PageNumber	integer	The page number of the returned data.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries that meet the conditions.	13
Files	array<object>	The file details.
	object	The file information.
CommitStatus	integer	The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed).	1
AutoParsing	boolean	Specifies whether automatic parsing is enabled for the file. Valid values: true: The file automatically parses code. false: The file does not automatically parse code. This parameter corresponds to Analyze Code when you set Dependencies to Same Cycle in the scheduling configuration of a Data Studio task in the DataWorks console.	true
Owner	string	The Alibaba Cloud account ID of the file owner.	3872572****
CreateTime	integer	The timestamp (in milliseconds) when the file was created.	1593950832000
FileType	integer	The file type. Different file types have different code. For more information, see DataWorks node types.	10
CurrentVersion	integer	The latest version of the file.	2
BizId	integer	The ID of the workflow to which the file belongs. This parameter is deprecated. Use the BusinessId parameter instead.	300000
LastEditUser	string	The Alibaba Cloud account ID of the user who last updated the file.	382762****
FileName	string	The file name.	ods_user_info_d
ConnectionName	string	The data source name used by the task.	odps_source
UseType	string	The functional module to which the file belongs. Valid values: NORMAL: Data Studio MANUAL: Manually triggered node MANUAL_BIZ: Manually triggered workflow SKIP: Dry-run scheduling in Data Studio ADHOCQUERY: Ad hoc query COMPONENT: Component management	NORMAL
FileFolderId	string	The ID of the folder where the file is located.	2735c2****
FileId	integer	The file ID.	10000001
ParentId	integer	If the current file is an internal file of a combined node, this parameter specifies the ID of the corresponding combined node file.	-1
CreateUser	string	The Alibaba Cloud account ID of the file creator.	382762****
IsMaxCompute	boolean	If the current file is a MaxCompute resource file, this parameter specifies whether the resource file needs to be uploaded to MaxCompute. You only need to configure this parameter when the file is a MaxCompute resource file.	false
BusinessId	integer	The ID of the workflow to which the file belongs.	300000
FileDescription	string	The description of the file.	my test datastudio file
LastEditTime	integer	The timestamp (in milliseconds) when the file was last modified.	1593950832000
Content	string	This parameter is deprecated. You can call the GetFile operation to query this information.	SHOW TABLES;
NodeId	integer	The ID of the scheduling task generated in the scheduling system after the file is committed.	300001
AbsoluteFolderPath	string	The path to the folder where the file is located.	Business_process/my_first_business_process/MaxCompute/ods_layer

Examples

Success response

JSON format

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