UpdateTaskAsync - 更新任务-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

更新指定任务，并同步到数据开发新增保存版本。

接口说明

请求说明

该 API 用于更新指定的任务信息，包括但不限于任务名称、描述、责任人等。
修改的内容会同步到数据开发，并且数据开发将新增一个保存版本。
支持设置任务的触发方式、运行环境配置以及依赖关系等详细参数。

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	任务 ID。	10001
ClientUniqueCode	string	否	任务的客户端唯一码，用来唯一标识一个任务。用于实现异步和幂等，创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。	Workflow_0bc5213917368545132902xxxxxxxx
EnvType	string	否	项目环境。 Prod：生产 Dev：开发	Prod
Name	string	否	名称。	name
Description	string	否	描述。	This is a description.
Owner	string	否	任务的责任人的账号 ID。您可以登录 DataWorks 控制台，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号 ID。如果该参数为空，则默认使用调用者的阿里云账号 ID。	1000000000001
InstanceMode	string	否	实例生成模式。 T+1（第二天生成） Immediately（立即生成）。注意：节点定时时间在节点发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（22:00~24:00 点期间）不能进行实时转实例，可以提交发布节点，但新增节点不会自动转出实例。	T+1
Timeout	integer	否	调度配置超时定义。	1
RerunMode	string	否	任务是否允许重跑的配置。 AllDenied：失败或成功都不可重跑 FailureAllowed：只有失败可重跑 AllAllowed：失败或成功均可重跑	AllAllowed
RerunTimes	integer	否	重试次数，当任务设置为可重跑时生效。	3
RerunInterval	integer	否	重试时间间隔，单位毫秒。（不得超过 1800000）	60000
Script	object	否	运行脚本信息。
Content `deprecated`	string	否	脚本内容。	echo "helloWorld"
Parameters	string	否	脚本参数列表。	para1=$bizdate
Trigger	object	否	任务触发方式。
Cron	string	否	Cron 表达式，type=Scheduler 时生效。	00 00 00 * * ?
CycleType	string	否	周期类型，Type=Scheduler 且 Cron 表达式为指定某小时定时调度时生效。默认为 Daily。 Daily：指定为天调度 NotDaily：指定为小时调度	Daily
EndTime	string	否	周期触发失效时间，type=Scheduler 时生效。格式为`yyyy-mm-dd hh:mm:ss`	9999-01-01 00:00:00
Recurrence	string	否	触发时的运行模式，type=Scheduler 时生效。 Pause：暂停 Skip：空跑 Normal：正常运行	Normal
StartTime	string	否	周期触发生效时间，type=Scheduler 时生效。格式为`yyyy-mm-dd hh:mm:ss`	1970-01-01 00:00:00
Type	string	否	触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	BySchedule
RuntimeResource	object	否	运行环境配置，如资源组信息。
Cu	string	否	任务运行配置 CU 消耗。	0.25
Image	string	否	任务运行配置的镜像 ID。	i-xxxxxx
ResourceGroupId	string	否	任务运行配置的调度资源组标识符。	63900680
DataSource	object	否	关联数据源信息。
Name	string	否	数据源名称。	odps_test
Inputs	object	否	输入信息。
Variables	array<object>	否	变量定义列表。
	object	否	变量定义列表。
Name	string	否	变量名称。	key1
Type	string	是	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	否	变量值。	value1
Outputs	object	否	输出信息。
TaskOutputs	array<object>	否	任务输出定义列表。
	object	否	任务输出定义列表。
Output	string	否	输出标识符。	pre.odps_sql_demo_0
Variables	array<object>	否	变量定义列表。
	object	否	变量定义列表。
Name	string	否	变量名称。	key1
Type	string	是	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	否	变量值。	value1
Dependencies	array<object>	否	依赖信息。
	object	否	依赖信息。
Type	string	是	依赖类型。 CrossCycleDependsOnChildren：跨周期依赖一级子节点 CrossCycleDependsOnSelf：跨周期依赖自己 CrossCycleDependsOnOtherNode：跨周期依赖其他节点 Normal：同周期依赖	Normal
UpstreamOutput	string	否	上游任务的输出标识符。（同周期依赖且设置 input 内容时，返回此字段）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任务的 Id。（`跨周期依赖其他节点`与`同周期依赖`未设置 input 内容时，返回此字段，其他情况不返回）	1234
Tags	array<object>	否	待绑定的数据资产标签列表
	object	否	任务标签列表。
Key	string	是	标签键。	tagKey
Value	string	否	标签值。	value

返回参数

名称	类型	描述	示例值
	object
OperationId	string	操作 ID，用于异步更新任务的结果，可通过`UpdateTaskAsync`接口获得。	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx
RequestId	string	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。	10000001

示例

正常返回示例

JSON格式

{
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx",
  "RequestId": "10000001"
}

错误码

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

变更历史

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