文档

UpdateFile - 更新已有的文件节点

更新时间:

调用UpdateFile更新已创建的文件。

接口说明

调试或调用该接口时,填写的参数必须与该节点原本的文件配置不同。例如,源节点的某参数值为 A,则需要变更为 B 后再提交。如果仍填写 A,会报 invalid 异常。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:UpdateFileWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
FileFolderPathstring

文件所在的路径。

业务流程/第一个业务流程/数据集成/文件夹1/文件夹2
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。

10000
FileNamestring

文件的名称。您可以通过重新设置 FileName 的值来修改文件名称。 例如,使用 ListFiles 接口查询目标目录下的文件 ID,通过 UpdateFile 接口,输入查询的文件 ID 至 FileId 参数,并配置 FileName 的参数值,即可修改相应文件的名称。

ods_user_info_d
FileDescriptionstring

文件的描述。

这里是文件描述
Contentstring

文件代码内容,不同代码类型(fileType)的文件,代码格式不同。您可以在运维中心,右键单击对应类型的任务,选择查看代码,查看具体的代码格式。

SELECT "1";
AutoRerunTimesinteger

文件出错后,自动重跑的次数。

3
AutoRerunIntervalMillisinteger

出错自动重跑时间间隔,单位为毫秒。最大为 1800000 毫秒(30 分钟)。

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

120000
RerunModestring

重跑属性。取值如下:

  • ALL_ALLOWED:运行成功或失败后皆可重跑。
  • FAILURE_ALLOWED:运行成功后不可重跑,运行失败后可以重跑。
  • ALL_DENIED:运行成功或失败皆不可重跑。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。

ALL_ALLOWED
Stopboolean

是否暂停调度,取值如下:

  • true:暂停调度。
  • false:不暂停调度。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。

false
ParaValuestring

调度参数。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>参数”对应。您可以参考调度参数配置。

x=a y=b z=c
StartEffectDatelong

开始自动调度的毫秒时间戳。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。

936923400000
EndEffectDatelong

停止自动调度的时间戳,单位为毫秒。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。

4155787800000
CronExpressstring

周期调度的 cron 表达式,该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>cron 表达式”对应。配置完“调度周期”及“定时调度时间”后,DataWorks 会自动生成相应 cron 表达式。

示例如下:

  • 每天凌晨 5 点 30 分定时调度:00 30 05 * * ?

  • 每个小时的第 15 分钟定时调度:00 15 * * * ?

  • 每隔十分钟调度一次:00 00/10 * * * ?

  • 每天 8 点到 17 点,每个十分钟调度一次:00 00-59/10 8-23 * * * ?

  • 每月的 1 日 0 点 20 分自动调度:00 20 00 1 * ?

  • 从 1 月 1 日 0 点 10 分开始,每过 3 个月调度一次:00 10 00 1 1-12/3 ?

  • 每周二、周五的 0 点 5 分自动调度:00 05 00 * * 2,5

由于 DataWorks 调度系统的规则,cron 表达式有以下限制:

  • 最短调度间隔时间为 5 分钟。

  • 每天最早调度时间为 0 点 5 分。

00 00-59/5 1-23 * * ?
CycleTypestring

调度周期的类型,包括 NOT_DAY(分钟、小时)和 DAY(日、周、月)。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>时间属性>调度周期”对应。

NOT_DAY
DependentTypestring

依赖上一周期的方式。取值如下:

  • SELF:依赖项选择本节点。
  • CHILD:依赖项选择一级子节点。
  • USER_DEFINE:依赖项选择其他节点。
  • NONE:未选择依赖项,即不会依赖上一周期。
USER_DEFINE
DependentNodeIdListstring

当 DependentType 参数配置为 USER_DEFINE 时,用于设置当前文件具体依赖的节点 ID。依赖多个节点时,使用英文逗号(,)分隔。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>调度依赖”配置为“上一周期”后,依赖项选择”其他节点“时配置的内容对应。

5,10,15,20
InputListstring

文件依赖的上游文件的输出名称。依赖多个输出时,使用英文逗号(,)分隔。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。

project_root,project.file1,project.001_out
ProjectIdentifierstring

DataWorks 工作空间的名称。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。

该参数与 ProjectId 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。

dw_project
FileIdlong

文件的 ID。您可以调用 ListFiles 接口获取文件 ID。

100000001
OutputListstring

文件的输出。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>调度依赖“选择”同周期“时的”本节点的输出名称”对应。

dw_project.ods_user_info_d
ResourceGroupIdentifierstring

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

default_group
ConnectionNamestring

文件对应任务执行时,任务使用的数据源标识符。您可以调用 ListDataSources 获取可用的数据源列表。

odps_source
Ownerstring

文件所有者的用户 ID。

18023848927592
AutoParsingboolean

文件是否开启自动解析功能。取值如下:

  • true:文件会自动解析代码。
  • false:文件不会自动解析代码。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。

true
SchedulerTypestring

调度的类型,取值如下:

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

任务的高级配置。

该参数与 DataWorks 控制台中,EMR Spark Streaming 和 EMR Streaming SQL 数据开发任务,编辑页面右侧导航栏的“高级设置“对应。

当前仅 EMR Spark Streaming 和 EMR Streaming SQL 任务支持配置该参数,并且参数为 JSON 格式。

{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
StartImmediatelyboolean

发布后是否立即启动。取值如下:

  • true:发布后立即启动。
  • false:发布后暂不启动。

该参数与 DataWorks 控制台中,EMR Spark Streaming 和 EMR Streaming SQL 数据开发任务,编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。

true
InputParametersstring

节点的上下文输入参数。参数为 JSON 格式,包含的字段可参考 GetFile 接口返回值中的 InputContextParameterList 参数结构。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>节点上下文>本节点输入参数“对应。

[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
OutputParametersstring

节点的上下文输出参数。参数为 JSON 格式,包含的字段可参考 GetFile 接口返回值中的 OutputContextParameterList 参数结构。

该参数与 DataWorks 控制台中,数据开发任务的“调度配置>节点上下文>本节点输出参数“对应。

[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningPropertyboolean

调度配置->上一周期->是否跳过上游的空跑属性

true

返回参数

名称类型描述示例值
object

返回结果。

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

0000-ABCD-EFGH-IJKLMNOPQ
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2024-04-03OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
2023-07-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
2023-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:IgnoreParentSkipRunningProperty
  • 本页导读 (1)