ListFiles_大数据开发治理平台 DataWorks_API文档

2020-05-18

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dataworks:*	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
FileFolderPathstring	文件所在的文件夹路径。示例值:Business_process/my_first_business_process/MaxCompute/ods_layer参考取值来源: CreateFile
ProjectIdinteger<int64>	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10000参考取值来源: ListProjectIds CreateProject AddProjectMemberToRole
Keywordstring	文件名称的关键字。支持模糊匹配，即输入关键字即可查询包含该关键字的所有文件。示例值:ods
ProjectIdentifierstring	DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。展开详情示例值:dw_project参考取值来源: CreateProject GetProject ListProjects
PageNumberinteger<int32>	请求的数据页数，用于翻页。示例值:1取值 >= 1
PageSizeinteger<int32>	每页显示的条数，默认为 10 条，最大为 100 条。示例值:10取值 <= 100
UseTypestring	文件所属的功能模块。取值如下：展开详情示例值:NORMAL
FileTypesstring	文件类型。不同文件类型其代码不同，详情请参见 DataWorks 节点合集。，查询文件的代码类型。示例值:10,23参考取值来源: GetFile
Ownerstring	文件责任人。示例值:3726346****
NodeIdinteger<int64>	调度节点的 ID。您可以调用 ListNodes 接口获取节点 ID。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:123541234参考取值来源: ListNodes
NeedContentboolean	查询结果是否包含文件内容（对于内容较多的文件，可能存在较长的网络传输延时）。示例值:false
NeedAbsoluteFolderPathboolean	查询结果是否包含文件所在的文件夹的路径。示例值:false
ExactFileNamestring	精确匹配的文件名称，查询结果的文件名称与该参数完全一致。示例值:ods_create.sql
FileIdInstring	Fileld 列表，查询结果的文件 ID 集合只能是该列表的子集。最多支持一次指定 50 个 FileId。示例值:78237,816123
LastEditUserstring	最近一次编辑文件的用户阿里云用户 ID。示例值:38748246285727
CommitStatusinteger<int32>	文件当前的提交状态，包括 0（未提交最新的代码）和 1（已提交最新的代码）。示例值:1枚举值:01

返回参数

字段名称	字段详情
HttpStatusCodeinteger<int32>	HTTP 状态码。示例值:200
ErrorMessagestring	错误信息。示例值:The connection does not exist.
RequestIdstring	请求 ID。用于出现错误后排查问题。示例值:0000-ABCD-****
ErrorCodestring	错误码。示例值:Invalid.Tenant.ConnectionNotExists
Successboolean	调用是否成功。取值如下：展开详情示例值:true
Dataobject	满足条件的文件列表。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	诊断
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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-04-07	新增请求参数CommitStatus
	2025-03-27	新增请求参数LastEditUser
	2023-07-14	新增请求参数NeedContent 新增请求参数NeedAbsoluteFolderPath 新增请求参数ExactFileName 新增请求参数FileIdIn 变更返回参数

1
2
10 条/页

相关示例

调用ListFiles查询文件列表。

2021-09-14