UpdateTask - 更新任务

更新指定任务。修改的内容会同步到数据开发,数据开发将新增一个保存版本。

调试

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

授权信息

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

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

请求参数

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

任务 ID。

1234
ClientUniqueCodestring

任务的客户端唯一码,用来唯一标识一个任务。用于实现异步和幂等,创建时如果不指定,系统将自动生成,该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数,应与创建时的客户端唯一码保持统一。

Task_0bc5213917368545132902xxxxxxxx
EnvTypestring

项目环境。

  • Prod:生产
  • Dev:开发
Prod
Namestring

名称。

SQL node
Descriptionstring

描述信息。

test
Ownerstring

任务的责任人的账号 ID。

1000
InstanceModestring

实例生成模式。

  • T+1(第二天生成)
  • Immediately(立即生成)
T+1
Timeoutinteger

任务执行超时时间,单位秒。取值应大于 3600。

3600
RerunModestring

任务是否允许重跑的配置。

  • AllDenied:失败或成功都不可重跑
  • FailureAllowed:只有失败可重跑
  • AllAllowed:失败或成功均可重跑
AllAllowed
RerunTimesinteger

重试次数,当任务设置为可重跑时生效。

3
RerunIntervalinteger

重试时间间隔,单位毫秒。(不得超过 1800000)

60000
Scriptobject

运行脚本信息。

Contentdeprecatedstring

脚本内容。

echo "helloWorld"
Parametersstring

脚本参数列表。

para1=$bizdate
Triggerobject

任务触发方式。

Typestring

触发方式类型。

  • Scheduler:调度周期触发
  • Manual:手动触发
Scheduler
Recurrencestring

触发时的运行模式,type=Scheduler 时生效。

  • Pause:暂停
  • Skip:空跑
  • Normal:正常运行
Normal
Cronstring

Cron 表达式,type=Scheduler 时生效。

00 00 00 * * ?
StartTimestring

周期触发生效时间,type=Scheduler 时生效。格式为yyyy-mm-dd hh:mm:ss

1970-01-01 00:00:00
EndTimestring

周期触发失效时间,type=Scheduler 时生效。格式为yyyy-mm-dd hh:mm:ss

9999-01-01 00:00:00
RuntimeResourceobject

运行环境配置,如资源组信息。

ResourceGroupIdstring

任务运行配置的调度资源组标识符。

S_res_group_524258031846018_1684XXXXXXXXX
Imagestring

任务运行配置的镜像 ID。

i-xxxxxx
Custring

任务运行配置 CU 消耗。

0.25
DataSourceobject

关联数据源信息。

Namestring

数据源名称。

odps_test
Inputsobject

输入信息。

Variablesarray<object>

变量定义列表。

Variableobject
Typestring

类型。

  • Constant:常量
  • PassThrough:参数节点输出
  • System:变量
  • NodeOutput:脚本输出
Constant
Valuestring

变量值。

value1
Namestring

变量名称。

key1
Outputsobject

输出信息。

TaskOutputsarray<object>

任务输出定义列表。

TaskOutputobject
Outputstring

输出标识符。

pre.odps_sql_demo_0
Variablesarray<object>

变量定义列表。

Variableobject
Typestring

类型。

  • Constant:常量
  • PassThrough:参数节点输出
  • System:变量
  • NodeOutput:脚本输出
Constant
Valuestring

变量值。

value1
Namestring

变量名称。

key1
Dependenciesarray<object>

依赖信息。

Dependenciesobject
Typestring

依赖类型。

  • CrossCycleDependsOnChildren:跨周期依赖一级子节点
  • CrossCycleDependsOnSelf:跨周期依赖自己
  • CrossCycleDependsOnOtherNode:跨周期依赖其他节点
  • Normal:同周期依赖
Normal
UpstreamOutputstring

上游任务的输出标识符。(同周期依赖且设置 input 内容时,返回此字段)

pre.odps_sql_demo_0
UpstreamTaskIdlong

上游任务的 Id。(跨周期依赖其他节点同周期依赖未设置 input 内容时,返回此字段,其他情况不返回)

1234
Tagsarray<object>

任务标签列表。

Tagobject
Valuestring

标签值。

value1
Keystring

标签键。

key1

返回参数

名称类型描述示例值
object
RequestIdstring

请求的 ID,用于定位日志,排查问题。

22C97E95-F023-56B5-8852-B1A77A17XXXX
Successboolean

操作是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史