调用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 |
文件名称的关键字。支持模糊匹配，即输入关键字即可查询包含该关键字的所有文件。 |
| ProjectIdentifier | String | 否 | dw_project |
DataWorks工作空间的名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。 该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。 |
| PageNumber | Integer | 否 | 1 |
请求的数据页数，用于翻页。 |
| PageSize | Integer | 否 | 10 |
每页显示的条数，默认为10条，最大为100条。 |
| UseType | String | 否 | NORMAL |
文件所属的功能模块。取值如下：
|
| 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。 |
| NeedContent | Boolean | 否 | false |
查询结果是否包含文件内容（对于内容较多的文件，可能存在较长的网络传输延时） |
| NeedAbsoluteFolderPath | Boolean | 否 | false |
查询结果是否包含文件所在的文件夹的路径 |
| ExactFileName | String | 否 | ods_create.sql |
精确匹配的文件名称，查询结果的文件名称与该参数完全一致 |
| FileIdIn | String | 否 | 78237,816123 |
Fileld列表，查询结果的文件ID集合只能是该列表的子集。最多支持一次指定50个FileId。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 |
调用是否成功。取值如下：
|
| Data | Object |
满足条件的文件列表。 |
|
| PageNumber | Integer | 1 |
请求的数据页数。 |
| PageSize | Integer | 10 |
每页显示的数据条数。 |
| TotalCount | Integer | 13 |
满足条件的数据总条数。 |
| Files | Array of File |
文件详情。 |
|
| CommitStatus | Integer | 1 |
文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）。 |
| AutoParsing | Boolean | true |
文件是否开启自动解析功能。取值如下：
该参数与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。 |
| UseType | String | NORMAL |
文件所属的功能模块。取值如下：
|
| FileFolderId | String | 2735c2**** |
文件所在文件夹的ID。 |
| FileId | Long | 10000001 |
文件的ID。 |
| ParentId | Long | -1 |
如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID。 |
| CreateUser | String | 382762**** |
文件创建者的阿里云用户ID。 |
| IsMaxCompute | Boolean | false |
如果当前文件是MaxCompute资源文件，该字段标识该资源文件是否需要上传至MaxCompute。 仅当文件是MaxCompute资源文件时才需要配置该参数。 |
| BusinessId | Long | 300000 |
文件所属的业务流程ID。 |
| FileDescription | String | my test datastudio file |
文件的描述信息。 |
| LastEditTime | Long | 1593950832000 |
最近一次编辑文件的毫秒时间戳。 |
| Content | String | SHOW TABLES; |
已废弃，查询请通过getfile。 |
| NodeId | Long | 300001 |
提交文件后，在调度系统生成的调度任务的ID。 |
| AbsoluteFolderPath | String | 业务流程/我的第一个业务流程/MaxCompute/ods层 |
文件所在的文件夹的路径 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListFiles
&FileFolderPath=业务流程/我的第一个业务流程/MaxCompute/ods层
&ProjectId=10000
&Keyword=ods
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&UseType=NORMAL
&FileTypes=10,23
&Owner=3726346****
&NodeId=123541234
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
The connection does not exist.
0000-ABCD-EFG
Invalid.Tenant.ConnectionNotExists
true
1
10
13
1
true
3872572****
1593950832000
10
2
300000
38748246285727
ods_user_info_d
odps_first
NORMAL
2735c2****
10000001
-1
382762****
false
300000
my test datastudio file
1593950832000
SHOW TABLES;
300001
JSON格式
HTTP/1.1 200 OK
Content-Type:application/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_first",
"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
}
}
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/171069.html