GetFile - 获取文件的详情 - 大数据开发治理平台 DataWorks

该接口用于获取文件的详情。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	否	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。	10000
ProjectIdentifier	string	否	DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。	dw_project
FileId	integer	否	文件的 ID。您可以调用 ListFiles 接口查询对应文件的 ID。	100000001
NodeId	integer	否	调度节点的 ID。您可以调用 ListFiles 接口获取节点 ID。	200000001

返回参数

名称	类型	描述	示例值
	object	返回结果。
HttpStatusCode	integer	HTTP 状态码。	200
ErrorMessage	string	错误信息。	The connection does not exist.
RequestId	string	请求 ID。用于出现错误后排查问题。	0000-ABCD-EFG****
ErrorCode	string	错误码。	Invalid.Tenant.ConnectionNotExists
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
Data	object	文件的详情。
File	object	文件的基本信息。
CommitStatus	integer	文件当前的提交状态，包括 0（未提交最新的代码）和 1（已提交最新的代码）。	0
AutoParsing	boolean	文件是否开启自动解析功能。取值如下： true：文件会自动解析代码。 false：文件不会自动解析代码。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。	true
Owner	string	文件责任人的阿里云用户 ID。	7775674356****
CreateTime	integer	文件创建的时间戳，单位为毫秒。	1593879116000
FileType	integer	文件的代码类型。文件类型，不同文件类型其代码不同，详情请参见 DataWorks 节点合集。	10
CurrentVersion	integer	文件当前已经提交的最新版本号。	3
BizId	integer	文件所属业务流程的 ID。该字段已废弃，请使用 BusinessId 字段。	1000001
LastEditUser	string	最近一次编辑文件的阿里云用户 ID。	62465892****
FileName	string	文件的名称。	ods_user_info_d
ConnectionName	string	执行文件对应的任务时，所使用的数据源名称。	odps_source
UseType	string	文件所属的功能模块。取值如下： NORMAL：数据开发。 MANUAL：手动任务。 MANUAL_BIZ：手动业务流程。 SKIP：数据开发的空跑调度。 ADHOCQUERY：临时查询。 COMPONENT：组件管理。	NORMAL
FileFolderId	string	文件所属文件夹的 ID。	2735c2****
ParentId	integer	如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的 ID。	-1
CreateUser	string	文件创建人的阿里云用户 ID。	424732****
IsMaxCompute	boolean	标识该资源文件是否需要上传至 MaxCompute。仅当文件是 MaxCompute 资源文件时才需要配置该参数。	true
BusinessId	integer	文件的业务流程 ID。	1000001
FileDescription	string	文件的描述信息。	My first DataWorks file
DeletedStatus	string	文件的删除状态。取值如下： NORMAL：未删除。 RECYCLE_BIN：回收站。 DELETED：被删除。	RECYCLE
LastEditTime	integer	最近一次编辑文件的时间戳，单位为毫秒。	1593879116000
Content	string	文件的代码。	SHOW TABLES;
NodeId	integer	提交文件后，在调度系统生成的调度任务 ID。	300001
AdvancedSettings	string	任务的高级配置。该参数与 DataWorks 控制台中，EMR 数据开发任务，编辑页面右侧导航栏的“高级设置“对应。说明当前 EMR Shell 任务不支持配置高级参数。各 EMR 任务开发的高级参数说明，请参见 EMR 任务开发。	{\"priority\":\"1\",\"ENABLE_SPARKSQL_JDBC\":false,\"FLOW_SKIP_SQL_ANALYZE\":false,\"queue\":\"default\"}
FileId	integer	文件的 ID。	100000001
NodeConfiguration	object	文件的调度配置。
RerunMode	string	重跑属性。取值如下： ALL_ALLOWED：运行成功或失败后皆可重跑。 FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。 ALL_DENIED：运行成功或失败皆不可重跑。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。	ALL_ALLOWED
SchedulerType	string	调度的类型，取值如下： NORMAL：正常调度任务。 MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。 PAUSE：暂停任务。 SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。	NORMAL
Stop	boolean	是否暂停调度，取值如下： true：暂停调度。 false：不暂停调度。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。	false
ParaValue	string	调度参数。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>参数”对应。您可以参考调度参数配置。	a=x b=y
StartEffectDate	integer	开始自动调度的毫秒时间戳。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。	936923400000
EndEffectDate	integer	停止自动调度的时间戳，单位为毫秒。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。	4155787800000
CycleType	string	调度周期的类型，包括 NOT_DAY（分钟、小时）和 DAY（日、周、月）。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>调度周期”对应。	DAY
DependentNodeIdList	string	当 DependentType 参数配置为 USER_DEFINE 时，用于设置当前文件具体依赖的节点 ID。依赖多个节点时，使用英文逗号（,）分隔。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖”配置为“上一周期”后，依赖项选择”其他节点“时配置的内容对应。	5,10,15,20
ResourceGroupId	integer	文件发布成任务后，任务执行时对应的资源组。您可以调用 ListResourceGroups 获取工作空间可用的资源组列表。	375827434852437
DependentType	string	依赖上一周期的方式。取值如下： SELF：依赖项选择本节点。 CHILD：依赖项选择一级子节点。 USER_DEFINE：依赖项选择其他节点。 NONE：未选择依赖项，即不会依赖上一周期。	USER_DEFINE
AutoRerunTimes	integer	出错自动重跑的次数。	3
AutoRerunIntervalMillis	integer	出错自动重跑时间间隔，单位为毫秒。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。	120000
CronExpress	string	文件定时调度的 cron 表达式。	00 05 00 * * ?
InputList	array<object>	文件依赖的上游文件输出。
	object	依赖的上游文件输出信息。
Input	string	文件依赖的上游文件的输出名称。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。	project.001_out
ParseType	string	配置文件依赖的方式，取值如下： MANUAL：手动配置。 AUTO：自动解析。	MANUAL
OutputList	array<object>	文件的输出。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”本节点的输出名称”对应。
	object	文件的输出信息。
RefTableName	string	文件的输出值。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出表”列的值对应。	ods_user_info_d
Output	string	文件的输出名称。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出名称”列值对应。	dw_project.002_out
StartImmediately	boolean	发布后是否立即启动。该参数与 DataWorks 控制台中，EMR Spark Streaming 和 EMR Streaming SQL 数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。	true
InputParameters	array<object>	节点上下文输入参数。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输入参数“对应。
	object	返回结果。
ParameterName	string	节点上下文输入参数的参数名称。在代码中可以使用${...}方式引用该参数。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”参数名“对应。	input
ValueSource	string	节点上下文输入参数的取值来源。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”取值来源“对应。	project_001.parent_node:outputs
OutputParameters	array<object>	节点上下文输出参数。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输出参数“对应。
	object	返回结果。
ParameterName	string	节点上下文输出参数的参数名称。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”参数名“对应。	output
Value	string	节点上下文输出参数的表达式。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”取值“对应。	${bizdate}
Type	string	节点上下文输出参数表达式的类型。取值如下： 1：表示常量。 2：表示变量。 3：表示参数节点透传变量。该参数与 DataWorks 控制台中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”类型“对应。	1
Description	string	节点上下文输出的参数描述。	It's a context output parameter.
ApplyScheduleImmediately	string	是否发布后立即生效调度配置	true
IgnoreParentSkipRunningProperty	string	调度配置->上一周期->是否跳过上游的空跑属性	true
Timeout	integer	调度配置超时定义	1
ImageId	string	自定义镜像 ID	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	资源下载地址
downloadLink	string	资源下载地址链接	http://xx

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "File": {
      "CommitStatus": 0,
      "AutoParsing": true,
      "Owner": "7775674356****",
      "CreateTime": 1593879116000,
      "FileType": 10,
      "CurrentVersion": 3,
      "BizId": 1000001,
      "LastEditUser": "62465892****",
      "FileName": "ods_user_info_d",
      "ConnectionName": "odps_source",
      "UseType": "NORMAL",
      "FileFolderId": "2735c2****",
      "ParentId": -1,
      "CreateUser": "424732****",
      "IsMaxCompute": true,
      "BusinessId": 1000001,
      "FileDescription": "My first DataWorks file",
      "DeletedStatus": "RECYCLE",
      "LastEditTime": 1593879116000,
      "Content": "SHOW TABLES;",
      "NodeId": 300001,
      "AdvancedSettings": "{\\\"priority\\\":\\\"1\\\",\\\"ENABLE_SPARKSQL_JDBC\\\":false,\\\"FLOW_SKIP_SQL_ANALYZE\\\":false,\\\"queue\\\":\\\"default\\\"}",
      "FileId": 100000001
    },
    "NodeConfiguration": {
      "RerunMode": "ALL_ALLOWED",
      "SchedulerType": "NORMAL",
      "Stop": false,
      "ParaValue": "a=x b=y",
      "StartEffectDate": 936923400000,
      "EndEffectDate": 4155787800000,
      "CycleType": "DAY",
      "DependentNodeIdList": "5,10,15,20",
      "ResourceGroupId": 375827434852437,
      "DependentType": "USER_DEFINE",
      "AutoRerunTimes": 3,
      "AutoRerunIntervalMillis": 120000,
      "CronExpress": "00 05 00 * * ?",
      "InputList": [
        {
          "Input": "project.001_out",
          "ParseType": "MANUAL"
        }
      ],
      "OutputList": [
        {
          "RefTableName": "ods_user_info_d",
          "Output": "dw_project.002_out"
        }
      ],
      "StartImmediately": true,
      "InputParameters": [
        {
          "ParameterName": "input",
          "ValueSource": "project_001.parent_node:outputs"
        }
      ],
      "OutputParameters": [
        {
          "ParameterName": "output",
          "Value": "${bizdate}",
          "Type": "1",
          "Description": "It's a context output parameter."
        }
      ],
      "ApplyScheduleImmediately": "true",
      "IgnoreParentSkipRunningProperty": "true",
      "Timeout": 1,
      "ImageId": "m-bp1h4b5a8ogkbll2f3tr"
    },
    "ResourceDownloadLink": {
      "downloadLink": "http://xx"
    }
  }
}

错误码

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.

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

变更历史

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