UpdateWorkflow - 更新工作流 -

以全量更新的方式，更新指定工作流。支持同步更新到数据开发的字段：责任人、数据源、调度资源组、描述信息、触发运行模式（正常、空跑、暂停）。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	工作流 ID。	1234
EnvType	string	否	项目环境。 Prod：生产 Dev：开发	Prod
Name	string	是	名称。	My Workflow
Owner	string	是	责任人的账号 ID。	1000
Trigger	object	是	触发方式。
Type	string	是	触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	Scheduler
Cron	string	否	Cron 表达式，type=Scheduler 时生效。	00 00 00 * * ?
StartTime	string	否	周期触发生效时间，type=Scheduler 时生效。格式为`yyyy-mm-dd hh:mm:ss`	1970-01-01 00:00:00
EndTime	string	否	周期触发失效时间，type=Scheduler 时生效。格式为`yyyy-mm-dd hh:mm:ss`	9999-01-01 00:00:00
Description	string	否	描述信息。	test
Dependencies	array<object>	否	依赖信息。
	object	否
Type	string	是	依赖类型。 CrossCycleDependsOnChildren：跨周期依赖一级子节点 CrossCycleDependsOnSelf：跨周期依赖自己 CrossCycleDependsOnOtherNode：跨周期依赖其他节点 Normal：同周期依赖	Normal
UpstreamOutput	string	否	上游任务的输出标识符。（`同周期依赖`且设置 input 内容时，返回此字段）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任务的 Id。（`跨周期依赖其他节点`与`同周期依赖`未设置 input 内容时，返回此字段，其他情况不返回）	1234
Parameters	string	否	参数列表。	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	否	任务列表。
	array<object>	否
Id	integer	否	任务 ID。填写此字段会对相应任务执行全量更新，未填写此字段则会创建新任务。	1234
Name	string	是	任务的名称。	SQL node
Description	string	否	描述信息。	Test
Type	string	是	任务类型。	ODPS_SQL
Owner	string	是	责任人的账号 ID。	1000
BaseLineId	integer	否	基线 ID。	1234
Timeout	integer	否	任务执行超时时间，单位秒。	3600
RerunMode	string	是	任务是否允许重跑的配置。 AllDenied：失败或成功都不可重跑 FailureAllowed：只有失败可重跑 AllAllowed：失败或成功均可重跑	AllAllowed
RerunTimes	integer	否	重试次数，当任务设置为可重跑时生效。	3
RerunInterval	integer	否	重试时间间隔，单位秒。	60
Script	object	否	运行脚本信息。
Content	string	否	脚本内容。	echo "helloWorld"
Parameters	string	否	脚本参数列表。	para1=$bizdate
Trigger	object	是	任务触发方式。
Type	string	否	触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	Scheduler
Recurrence	string	是	触发时的运行模式，type=Scheduler 时生效。 Pause：暂停 Skip：空跑 Normal：正常运行	Normal
RuntimeResource	object	是	运行环境配置，如资源组信息。
ResourceGroupId	string	是	任务运行配置的调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	否	任务运行配置的镜像 ID。	i-xxxxxx
Cu	string	否	任务运行配置 CU 消耗。	0.25
DataSource	object	否	关联数据源信息。
Name	string	否	数据源名称。	odps_test
Inputs	object	否	输入信息。注意，此字段为空时将默认删除所有 Inputs 配置。
Variables	array<object>	否	变量定义列表。注意，此字段未填或为空数组时将默认删除所有 Inputs.Variables 配置。
	object	否
Name	string	否	变量名称。	key1
Type	string	是	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	否	变量值。	value1
Outputs	object	否	输出信息。注意，此字段为空时将默认删除所有 Outputs 配置。
TaskOutputs	array<object>	否	任务输出定义列表。注意，此字段未填或为空数组时将默认删除所有 TaskOutputs 配置。
	object	否
Output	string	否	输出标识符。	pre.odps_sql_demo_0
Variables	array<object>	否	变量定义列表。注意，此字段未填或为空数组时将默认删除所有 Outputs.Variables 配置。
	object	否
Name	string	否	变量名。	key1
Type	string	是	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	否	变量值。	value1
Dependencies	array<object>	否	依赖信息。注意，此字段未填或为空数组时将默认删除所有 Dependencies 配置。
	object	否
Type	string	是	依赖类型。 CrossCycleDependsOnChildren：跨周期依赖一级子节点 CrossCycleDependsOnSelf：跨周期依赖自己 CrossCycleDependsOnOtherNode：跨周期依赖其他节点 Normal：同周期依赖	Normal
UpstreamOutput	string	否	上游任务的输出标识符。（`同周期依赖`且设置 input 内容时，返回此字段）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任务的 Id。（`跨周期依赖其他节点`与`同周期依赖`未设置 input 内容时，返回此字段，其他情况不返回）	1234
Tags	array<object>	否	任务标签列表。注意，此字段未填或为空数组时将默认删除所有 Tags 配置。
	object	否
Key	string	是	标签键。	key1
Value	string	否	标签值。	value1
ClientUniqueCode	string	否	任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	否	项目环境。 Prod：生产 Dev：开发	Prod
Outputs	object	否	输出信息。
TaskOutputs	array<object>	否	工作流任务输出定义列表。
	object	否
Output	string	否	输出标识符。	pre.odps_sql_demo_0
Tags	array<object>	否	工作流标签列表。
	object	否
Key	string	是	标签键。	key1
Value	string	否	标签值。	value1
ClientUniqueCode	string	否	工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	否	实例生成模式。 T+1（第二天生成） Immediately（立即生成）。注意：工作流定时时间在工作流发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（22:00~24:00 点期间）不能进行实时转实例，可以提交发布工作流，但提交后不会重新生成实例。	T+1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Success	boolean	操作是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

错误码

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

变更历史

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