调用ListFiles查询文件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFiles

要执行的操作。

FileFolderPath String 业务流程/我的第一个业务流程/MaxCompute/ods层

文件所在的文件夹路径。

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。

该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

Keyword String ods

文件名称的关键字。支持模糊匹配,即输入关键字即可查询包含该关键字的所有文件。

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectIdentifier String dw_project

DataWorks工作空间的名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。

该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

PageNumber Integer 1

请求的数据页数,用于翻页。

PageSize Integer 10

每页显示的条数,默认为10条,最大为100条。

UseType String NORMAL

文件所属的功能模块。取值如下:

  • NORMAL:数据开发。
  • MANUAL:手动任务。
  • MANUAL_BIZ:手动业务流程。
  • SKIP:数据开发的空跑调度。
  • ADHOCQUERY:临时查询。
  • COMPONENT:组件管理。
FileTypes String 10,23

文件的代码类型。

常用的代码及其对应的文件类型包括6(Shell)、10(ODPS SQL)、11(ODPS MR)、23(数据集成)、24(ODPS Script)、97(PAI)、98(组合节点)、99(虚拟节点)、221(PyODPS 2)、225(ODPS Spark)、227(EMR Hive)、228(EMR Spark)、229(EMR Spark SQL)、230(EMR MR)、239(OSS对象检查)、257(EMR Shell)、258(EMR Spark Shell)、259(EMR Presto)、260(EMR Impala)、900(实时同步)、1002(PAI内部节点)、1089(跨租户节点)、1091(Hologres开发)、1093(Hologres SQL)、1100(赋值节点)、1106(遍历节点(foreach))、1221(PyODPS 3)。

Owner String 3726346****

文件责任人。

NodeId Long 123541234

调度节点的ID。您可以调用ListNodes接口获取节点ID。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

HTTP状态码。

ErrorMessage String The connection does not exist.

错误信息。

RequestId String 0000-ABCD-EFG

请求ID。用于出现错误后排查问题。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

Success Boolean true

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
Data Object

满足条件的文件列表。

PageNumber Integer 1

请求的数据页数。

PageSize Integer 10

每页显示的数据条数。

TotalCount Integer 13

满足条件的数据总条数。

Files Array of File

文件详情。

CommitStatus Integer 1

文件当前的提交状态,包括0(未提交最新的代码)和1(已提交最新的代码)。

AutoParsing Boolean true

文件是否开启自动解析功能。取值如下:

  • true:文件会自动解析代码。
  • false:文件不会自动解析代码。

该参数与DataWorks控制台中,数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。

Owner String 3872572****

文件责任人的阿里云用户ID。

CreateTime Long 1593950832000

文件创建时间的毫秒时间戳。

FileType Integer 10

文件的代码类型。常用的代码及其对应的文件类型包括6(Shell)、10(ODPS SQL)、11(ODPS MR)、23(数据集成)、24(ODPS Script)、99(虚拟节点)、221(PyODPS 2)、225(ODPS Spark)、227(EMR Hive)、228(EMR Spark)、229(EMR Spark SQL)、230(EMR MR)、239(OSS对象检查)、257(EMR Shell)、258(EMR Spark Shell)、259(EMR Presto)、260(EMR Impala)、900(实时同步)、1089(跨租户节点)、1091(Hologres开发)、1093(Hologres SQL)、1100(赋值节点)、1221(PyODPS 3)。

CurrentVersion Integer 2

文件当前已经提交的最新版本号。

BizId Long 300000

文件所属的业务流程ID。该字段已废弃,请使用BusinessId字段。

LastEditUser String 38748246285727

最近一次编辑文件的用户阿里云用户ID。

FileName String ods_user_info_d

文件的名称。

ConnectionName String odps_first

文件对应的任务执行时所使用的引擎实例ID。