调用ListFiles查询文件列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListFiles |
要执行的操作。 |
ProjectId | Long | 是 | 10000 |
Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。 |
RegionId | String | 是 | cn-zhangjiakou |
地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。 |
FileFolderPath | String | 否 | 业务流程/我的第一个业务流程/MaxCompute/ods层 |
文件所在的文件夹路径。 |
Keyword | String | 否 | ods |
文件名称的关键字,用于模糊匹配。 |
ProjectIdentifier | String | 否 | dw_project |
Dataworks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。 该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的Dataworks工作空间。 |
PageNumber | Integer | 否 | 1 |
请求的数据页数,用于翻页。 |
PageSize | Integer | 否 | 10 |
每页显示的条数,默认为10条,最大100条。 |
UseType | String | 否 | 0 |
文件所属的功能模块,包括NORMAL(数据开发)、MANUAL(手动任务)、MANUAL_BIZ(手动工作流)、SKIP(数据开发空跑调度)、ADHOCQUERY(临时查询)和COMPONENT(组件管理)。 |
FileTypes | String | 否 | 10,23 |
文件的代码类型,常用的代码类型包括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)。 |
Owner | String | 否 | 3726346**** |
文件责任人。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
满足条件的文件列表。 |
|
Files | Array of File |
文件详情。 |
|
BizId | Long | 300000 |
文件所属的业务流程ID。 |
CommitStatus | Integer | 1 |
文件当前的提交状态,包括0(未提交最新的代码)和1(已提交最新的代码)。 |
ConnectionName | String | odps_first |
文件对应的任务执行时所使用的引擎实例ID。 |
Content | String | SHOW TABLES; |
文件代码。 |
CreateTime | Long | 1593950832000 |
文件创建时间的毫秒时间戳。 |
CreateUser | String | 382762**** |
文件创建人的阿里云用户ID。 |
CurrentVersion | Integer | 2 |
文件当前已经提交的最新版本号。 |
FileDescription | String | my test datastudio file |
文件的描述信息。 |
FileFolderId | String | 2735c2**** |
文件所在文件夹的ID。 |
FileId | Long | 10000001 |
文件的ID。 |
FileName | String | ods_user_info_d |
文件的名称。 |
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)。 |
IsMaxCompute | Boolean | false |
如果当前文件是MaxCompute资源文件,该字段标识该资源文件是否需要上传至MaxCompute。 |
LastEditTime | Long | 1593950832000 |
文件最近被编辑的毫秒时间戳。 |
LastEditUser | String | 38748246285727 |
最近一次编辑文件的用户阿里云用户ID。 |
NodeId | Long | 300001 |
提交文件后,在调度系统生成的调度任务的ID。 |
Owner | String | 3872572**** |
文件责任人的阿里云用户ID。 |
ParentId | Long | -1 |
如果当前文件是组合节点文件的内部文件,该字段标识对应组合节点文件的ID。 |
UseType | String | 0 |
文件所属的功能模块,包括0(数据开发)、1(手动任务)、2(手动工作流)、3(数据开发的空跑调度)、10(临时查询)和30(组件管理)。 |
PageNumber | Integer | 1 |
请求的数据页数。 |
PageSize | Integer | 10 |
请求的数据页大小。 |
TotalCount | Integer | 13 |
满足条件的数据总条数。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
ErrorMessage | String | The connection does not exist. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
RequestId | String | 0000-ABCD-EFG |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListFiles
&FileFolderPath=业务流程/我的第一个业务流程/MaxCompute/ods层
&Keyword=ods
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFG</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
<TotalCount>13</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Files>
<ParentId>-1</ParentId>
<Owner>3872572****</Owner>
<CreateTime>1593950832000</CreateTime>
<FileName>ods_user_info_d</FileName>
<UseType>0</UseType>
<CurrentVersion>2</CurrentVersion>
<CreateUser>382762****</CreateUser>
<IsMaxCompute>false</IsMaxCompute>
<ConnectionName>odps_first</ConnectionName>
<LastEditTime>1593950832000</LastEditTime>
<FileDescription>my test datastudio file</FileDescription>
<FileType>10</FileType>
<Content>SHOW TABLES;</Content>
<LastEditUser>387482****</LastEditUser>
<NodeId>300001</NodeId>
<CommitStatus>1</CommitStatus>
<FileFolderId>2735c2****</FileFolderId>
<BizId>300000</BizId>
</Files>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
JSON
格式
{
"RequestId": "0000-ABCD-EFG",
"HttpStatusCode": 200,
"Data": {
"TotalCount": 13,
"PageSize": 10,
"PageNumber": 1,
"Files": {
"ParentId": -1,
"Owner": "3872572****",
"CreateTime": 1593950832000,
"FileName": "ods_user_info_d",
"UseType": 0,
"CurrentVersion": 2,
"CreateUser": "382762****",
"IsMaxCompute": false,
"ConnectionName": "odps_first",
"LastEditTime": 1593950832000,
"FileDescription": "my test datastudio file",
"FileType": 10,
"Content": "SHOW TABLES;",
"LastEditUser": "387482****",
"NodeId": 300001,
"CommitStatus": 1,
"FileFolderId": "2735c2****",
"BizId": 300000
}
},
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"ErrorMessage": "The connection does not exist.",
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
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. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交