AI 助理
文档备案控制台
官方文档
首页 大数据开发治理平台 DataWorks 开发参考 API参考（2024-05-18） API目录 数据开发（旧版） 文件 ListFiles - 查询文件列表

ListFiles - 查询文件列表

更新时间：
复制 MD 格式
产品详情
我的收藏

调用ListFiles查询文件列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值
FileFolderPath

string

否

文件所在的文件夹路径 。

Business_process/my_first_business_process/MaxCompute/ods_layer
ProjectId

integer

否

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

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

10000
Keyword

string

否

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

ods
ProjectIdentifier

string

否

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

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

dw_project
PageNumber

integer

否

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

1
PageSize

integer

否

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

10
UseType

string

否

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

  • NORMAL：数据开发。

  • MANUAL：手动任务。

  • MANUAL_BIZ：手动业务流程。

  • SKIP：数据开发的空跑调度。

  • ADHOCQUERY：临时查询。

  • COMPONENT：组件管理。

NORMAL
FileTypes

string

否

文件的代码类型。

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

string

否

文件责任人 。

3726346****
NodeId

integer

否

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

123541234
NeedContent

boolean

否

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

false
NeedAbsoluteFolderPath

boolean

否

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

false
ExactFileName

string

否

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

ods_create.sql
FileIdIn

string

否

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

78237,816123
LastEditUser

string

否

文件最后更新人的阿里云 ID。

11233***
CommitStatus

integer

否

文件当前的提交状态， 包括 0（未提交最新的代码）和 1（已提交最新的代码）。

1

返回参数

名称

类型

描述

示例值

object

返回结果 。

HttpStatusCode

integer

HTTP 状态码 。

200
ErrorMessage

string

错误信息 。

The connection does not exist.
RequestId

string

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

0000-ABCD-****
ErrorCode

string

错误码 。

Invalid.Tenant.ConnectionNotExists
Success

boolean

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

  • true：调用成功。

  • false：调用失败。

true
Data

object

返回数据详情 。

PageNumber

integer

请求的数据页数 。

1
PageSize

integer

每页显示的数据条数 。

10
TotalCount

integer

满足条件的数据总条数 。

13
Files

array<object>

文件详情 。

object

文件信息 。

CommitStatus

integer

文件当前的提交状态，包括 0（未提交最新的代码）和 1（已提交最新的代码） 。

1
AutoParsing

boolean

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

  • true：文件会自动解析代码。

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

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

true
Owner

string

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

3872572****
CreateTime

integer

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

1593950832000
FileType

integer

文件类型。不同文件类型其代码不同，详情请参见 DataWorks 节点合集 。

10
CurrentVersion

integer

当前文件的最新版本 。

2
BizId

integer

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

300000
LastEditUser

string

文件最后更新人的阿里云 ID 。

382762****
FileName

string

文件的名称 。

ods_user_info_d
ConnectionName

string

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

odps_source
UseType

string

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

  • NORMAL：数据开发。

  • MANUAL：手动任务。

  • MANUAL_BIZ：手动业务流程。

  • SKIP：数据开发的空跑调度。

  • ADHOCQUERY：临时查询。

  • COMPONENT：组件管理。

NORMAL
FileFolderId

string

文件所在文件夹的 ID 。

2735c2****
FileId

integer

文件的 ID 。

10000001
ParentId

integer

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

-1
CreateUser

string

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

382762****
IsMaxCompute

boolean

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

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

false
BusinessId

integer

文件所属的业务流程 ID 。

300000
FileDescription

string

文件的描述信息 。

my test datastudio file
LastEditTime

integer

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

1593950832000
Content

string

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

SHOW TABLES;
NodeId

integer

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

300001
AbsoluteFolderPath

string

文件所在的文件夹的路径 。

Business_process/my_first_business_process/MaxCompute/ods_layer

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
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. 没有权限，请授权
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.

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

变更历史

更多信息，参考变更详情。

上一篇：GetFile - 获取文件的详情下一篇：SubmitFile - 提交文件至调度系统开发环境