调用GetFile获取文件的详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetFile

要执行的操作。

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks管控台,进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

ProjectIdentifier String dw_project

DataWorks工作空间名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

FileId Long 100000001

文件的ID,您可以通过ListFiles查询对应文件的ID。

NodeId Long 200000001

调度节点ID。

返回数据

名称 类型 示例值 描述
Data Struct

文件的详情。

File Struct

文件的基本信息。

AutoParsing Boolean true

文件的自动解析开关,对应数据开发页面 调度配置 > 调度依赖 > 自动解析 选项。

BizId Long 1000001

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

BusinessId Long 1000001

文件的业务流程ID。

CommitStatus Integer 0

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

ConnectionName String odps_first

执行文件对应的任务时,所使用的引擎实例ID。

Content String SHOW TABLES;

文件的代码。

CreateTime Long 1593879116000

文件创建的时间戳,单位为毫秒。

CreateUser String 424732****

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

CurrentVersion Integer 3

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

DeletedStatus String RECYCLE

文件的删除状态:NORMAL

  • 未删除、RECYCLE_BIN
  • 回收站、DELETED
  • 被删除。
FileDescription String 我的第一个Dataworks文件

文件的描述信息。

FileFolderId String 2735c2****

文件所属文件夹的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 true

标识该资源文件是否需要上传至MaxCompute。

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

LastEditTime Long 1593879116000

最近一次编辑文件的时间戳,单位为毫秒。

LastEditUser String 62465892****

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

NodeId Long 300001

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

Owner String 7775674356****

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

ParentId Long -1

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

UseType String NORMAL

文件所属的功能模块,包括NORMAL(数据开发)、MANUAL(手动任务)、MANUAL_BIZ(手动工作流)、SKIP(数据开发的空跑调度)、ADHOCQUERY(临时查询)和COMPONENT(组件管理)。

NodeConfiguration Struct

文件的调度配置。

AutoRerunIntervalMillis Integer 120000

出错自动重跑时间间隔,单位为毫秒。

该参数对应DataWorks控制台中“调度配置>时间属性>出错自动重跑间隔”配置。控制台中“出错自动重跑间隔”的时间单位为分钟,请在调用时注意转换时间。

AutoRerunTimes Integer 3

出错自动重跑的次数。

CronExpress String 00 05 00 * * ?

文件定时调度的cron表达式。

CycleType String DAY

调度周期的类型,包括NOT_DAY(分钟、小时)和DAY(日、周、月),该参数对应DataWorks控制台中“调度配置>时间属性>调度周期”配置。

DependentNodeIdList String 5,10,15,20

当DependentType参数配置为USER_DEFINE时,用于设置具体依赖的节点ID,依赖多个节点时,使用英文逗号(,)分隔。该参数对应DataWorks控制台中,勾选“调度配置>时间属性>依赖上一周期”后,依赖项选择自定义时需要配置的内容。

DependentType String USER_DEFINE

依赖上一周期的方式,包括NONE(取消勾选依赖上一周期)、SELF(本节点)、CHILD(一层子节点)和USER_DEFINE(自定义)。

EndEffectDate Long 4155787800000

停止自动调度的时间戳,单位为毫秒。该参数对应DataWorks控制台中,“调度配置>时间属性>生效时间”配置的结束时间的毫秒时间戳。

InputList Array of NodeInputOutput

文件依赖的上游文件的输出。该参数对应DataWorks控制台中的“调度配置>调度依赖>父节点输出名称”。

Input String project.001_out

文件依赖的上游文件的输出。该参数对应DataWorks控制台中的“调度配置>调度依赖>父节点输出名称”列的值。

ParseType String MANUAL
OutputList Array of NodeInputOutput

文件的输出。该参数对应DataWorks控制台中的“调度配置>调度依赖>本节点的输出名称”。

Output String dw_project.002_out

文件的输出。该参数对应DataWorks控制台中的“调度配置>调度依赖>本节点的输出名称”列的值。

RefTableName String ods_user_info_d

文件的输出。该参数对应DataWorks控制台中的“调度配置>调度依赖>本节点的输出表”列的值。

ParaValue String a=x b=y

调度参数。该参数对应DataWorks控制台中的“调度配置>基础属性>参数”。

RerunMode String ALL_ALLOWED

重跑属性,包括ALL_ALLOWED(运行成功或失败后皆可重跑)、FAILURE_ALLOWED(运行成功后不可重跑,运行失败后可以重跑)和ALL_DENIED(运行成功或失败皆不可重跑)。

该参数对应DataWorks控制台中的“调度配置>时间属性>重跑属性”。

ResourceGroupId Long 375827434852437

文件发布成任务后,任务执行时对应的资源组。您可以调用ListResourceGroups获取工作空间可用的资源组列表。

SchedulerType String NORMAL

调度的类型,取值如下:

  • NORMAL:正常调度任务。
  • MANUAL:手动任务,不会被日常调度,对应手动业务流程下的节点。
  • PAUSE:暂停任务。
  • SKIP:空跑任务,被日常调度,但启动调度时直接被置为成功。
StartEffectDate Long 936923400000

开始自动调度的毫秒时间戳。该参数对应DataWorks控制台中,“调度配置>时间属性>生效时间”配置的开始时间的毫秒时间戳。

Stop Boolean false

是否暂停调度。该参数对应DataWorks控制台中的“调度配置>时间属性>暂停调度”。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

ErrorMessage String The connection does not exist.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetFile
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <File>
        <ParentId>-1</ParentId>
        <Owner>7775674356****</Owner>
        <CurrentVersion>3</CurrentVersion>
        <UseType>0</UseType>
        <FileName>ods_user_info_d</FileName>
        <CreateTime>1593879116000</CreateTime>
        <CreateUser>424732****</CreateUser>
        <IsMaxCompute>true</IsMaxCompute>
        <ConnectionName>odps_first</ConnectionName>
        <LastEditTime>1593879116000</LastEditTime>
        <FileDescription>我的第一个Dataworks文件</FileDescription>
        <FileType>10</FileType>
        <LastEditUser>62465892****</LastEditUser>
        <Content>SHOW TABLES;</Content>
        <CommitStatus>0</CommitStatus>
        <NodeId>300001</NodeId>
        <FileFolderId>2735c2****</FileFolderId>
        <BizId>1000001</BizId>
    </File>
    <NodeConfiguration>
        <EndEffectDate>4155787800000</EndEffectDate>
        <CycleType>DAY</CycleType>
        <ResourceGroupId>375827434852437</ResourceGroupId>
        <DependentNodeIdList>5,10,15,20</DependentNodeIdList>
        <AutoRerunIntervalMillis>120000</AutoRerunIntervalMillis>
        <StartEffectDate>936923400000</StartEffectDate>
        <Stop>false</Stop>
        <DependentType>USER_DEFINE</DependentType>
        <AutoRerunTimes>3</AutoRerunTimes>
        <RerunMode>ALL_ALLOWED</RerunMode>
        <ParaValue>a=x b=y</ParaValue>
        <CronExpress>00 05 00 * * ?</CronExpress>
        <InputList>
            <Input>project.001_out</Input>
        </InputList>
        <OutputList>
            <Output>dw_project.002_out</Output>
            <RefTableName>ods_user_info_d</RefTableName>
        </OutputList>
    </NodeConfiguration>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON格式

{"RequestId":"0000-ABCD-EFG****","HttpStatusCode":"200","Data":{"File":{"ParentId":"-1","Owner":"7775674356****","CurrentVersion":"3","UseType":"0","FileName":"ods_user_info_d","CreateTime":"1593879116000","CreateUser":"424732****","IsMaxCompute":"true","ConnectionName":"odps_first","LastEditTime":"1593879116000","FileDescription":"我的第一个Dataworks文件","FileType":"10","LastEditUser":"62465892****","Content":"SHOW TABLES;","DeletedStatus":"","CommitStatus":"0","NodeId":"300001","AutoParsing":"true","FileFolderId":"2735c2****","BizId":"1000001","BusinessId":"1000001"},"NodeConfiguration":{"EndEffectDate":"4155787800000","CycleType":"DAY","ResourceGroupId":"375827434852437","DependentNodeIdList":"5,10,15,20","AutoRerunIntervalMillis":"120000","StartEffectDate":"936923400000","Stop":"false","DependentType":"USER_DEFINE","AutoRerunTimes":"3","RerunMode":"ALL_ALLOWED","ParaValue":"a=x b=y","CronExpress":"00 05 00 * * ?","InputList":[{"ParseType":"","Input":"project.001_out"}],"OutputList":[{"Output":"dw_project.002_out","RefTableName":"ods_user_info_d"}]}},"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企业版或旗舰版。

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