调用ListFiles查询文件列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileFolderPath | string | 否 | 文件所在的文件夹路径。 | 业务流程/我的第一个业务流程/MaxCompute/ods层 |
| ProjectId | long | 否 | 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 |
| FileTypes | string | 否 | 文件类型。不同文件类型其代码不同，详情请参见 DataWorks 节点合集。，查询文件的代码类型。 | 10,23 |
| Owner | string | 否 | 文件责任人。 | 3726346**** |
| NodeId | long | 否 | 调度节点的 ID。您可以调用 ListNodes 接口获取节点 ID。 | 123541234 |
| NeedContent | boolean | 否 | 查询结果是否包含文件内容（对于内容较多的文件，可能存在较长的网络传输延时）。 | false |
| NeedAbsoluteFolderPath | boolean | 否 | 查询结果是否包含文件所在的文件夹的路径。 | false |
| ExactFileName | string | 否 | 精确匹配的文件名称，查询结果的文件名称与该参数完全一致。 | ods_create.sql |
| FileIdIn | string | 否 | Fileld 列表，查询结果的文件 ID 集合只能是该列表的子集。最多支持一次指定 50 个 FileId。 | 78237,816123 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | DataWorks系统繁忙，请稍后再试。 |
| 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. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |