文档

ListFiles - 查询文件列表

更新时间:

调用ListFiles查询文件列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

名称类型必填描述示例值
FileFolderPathstring

文件所在的文件夹路径。

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

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

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

10000
Keywordstring

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

ods
ProjectIdentifierstring

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

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

dw_project
PageNumberinteger

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

1
PageSizeinteger

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

10
UseTypestring

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

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

文件的代码类型。

常用的代码及其对应的文件类型包括 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)。

10,23
Ownerstring

文件责任人。

3726346****
NodeIdlong

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

123541234
NeedContentboolean

查询结果是否包含文件内容(对于内容较多的文件,可能存在较长的网络传输延时)。

false
NeedAbsoluteFolderPathboolean

查询结果是否包含文件所在的文件夹的路径。

false
ExactFileNamestring

精确匹配的文件名称,查询结果的文件名称与该参数完全一致。

ods_create.sql
FileIdInstring

Fileld 列表,查询结果的文件 ID 集合只能是该列表的子集。最多支持一次指定 50 个 FileId。

78237,816123

返回参数

名称类型描述示例值
object

返回结果。

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

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

0000-ABCD-EFG
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

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

  • true:调用成功。
  • false:调用失败。
true
Dataobject

满足条件的文件列表。

PageNumberinteger

请求的数据页数。

1
PageSizeinteger

每页显示的数据条数。

10
TotalCountinteger

满足条件的数据总条数。

13
Filesobject []

文件详情。

CommitStatusinteger

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

1
AutoParsingboolean

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

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

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

true
Ownerstring

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

3872572****
CreateTimelong

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

1593950832000
FileTypeinteger

文件的代码类型。常用的代码及其对应的文件类型包括 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)。

10
CurrentVersioninteger

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

2
BizIdlong

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

300000
LastEditUserstring

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

38748246285727
FileNamestring

文件的名称。

ods_user_info_d
ConnectionNamestring

文件对应的任务执行时所使用的数据源名称。

odps_source
UseTypestring

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

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

文件所在文件夹的 ID。

2735c2****
FileIdlong

文件的 ID。

10000001
ParentIdlong

如果当前文件是组合节点文件的内部文件,该字段标识对应组合节点文件的 ID。

-1
CreateUserstring

文件创建者的阿里云用户 ID。

382762****
IsMaxComputeboolean

如果当前文件是 MaxCompute 资源文件,该字段标识该资源文件是否需要上传至 MaxCompute。

仅当文件是 MaxCompute 资源文件时才需要配置该参数。

false
BusinessIdlong

文件所属的业务流程 ID。

300000
FileDescriptionstring

文件的描述信息。

my test datastudio file
LastEditTimelong

最近一次编辑文件的毫秒时间戳。

1593950832000
Contentstring

该参数已废弃。您可通过 GetFile 接口查询。

SHOW TABLES;
NodeIdlong

提交文件后,在调度系统生成的调度任务的 ID。

300001
AbsoluteFolderPathstring

文件所在的文件夹的路径

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

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG",
  "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": "38748246285727",
        "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": "业务流程/我的第一个业务流程/MaxCompute/ods层"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:NeedContent
    新增入参:NeedAbsoluteFolderPath
    新增入参:ExactFileName
    新增入参:FileIdIn
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)