调用UpdateJob更新任务配置信息。默认先调用获取任务找到对应字段进行修改。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateJob

系统规定参数。取值为UpdateJob

ExecuteMode String standalone

任务执行模式,目前支持以下几种任务执行模式:

  • 单机运行:standalone
  • 广播运行:broadcatst
  • 并行计算:parallel
  • 内存网格:grid
  • 网格计算:batch
  • 分片运行:shard
GroupId String testSchedulerx.defaultGroup

应用ID,在控制台的应用管理页面中获取。

JobId Long 92583

任务ID,在控制台的任务管理页面中获取。

Name String helloword

任务名。

Namespace String adcfc35d-e2fe-4fe9-bbaa-20e90ffc****

命名空间ID,在控制台的命名空间页面中获取。

RegionId String cn-hangzhou

地域ID。

TimeType Integer 1

时间配置类型,目前支持以下几种配置类型:

  • cron:1
  • fix_rate:3
  • second_delay:4
  • api:100
Description String test

任务描述。

Content String echo 'hello'

任务类型为pythonshellgo的必填脚本内容。

Parameters String test

用户自定义参数,运行时可以获取。

MaxConcurrency Integer 1

最大同时运行实例数量,默认值为1,即上次触发没有运行结束,不会进行下次触发即使到了运行时刻。

MaxAttempt Integer 0

错误最大重试次数,根据业务需求填写。

AttemptInterval Integer 30

错误重试间隔时间,单位s,默认值为30。

ClassName String com.alibaba.test.helloworld

任务接口类完整路径。

是Java任务类型时,才有该字段且必须填写完整路径。

JarUrl String 暂不支持,不用填写

上传到OSS的完整路径。

如果选择JAR包运行,可以将相应JAR包上传到OSS的该路径下。

PageSize Integer 100

并行网格任务高级配置,单次拉取子任务数,默认值为100。

ConsumerSize Integer 5

并行网格任务高级配置,单机单次触发执行线程数,默认值为5。

QueueSize Integer 10000

并行网格任务高级配置,子任务队列缓存上限,默认值为10000。

DispatcherSize Integer 5

并行网格任务高级配置,子任务分发线程数,默认值为5。

TimeExpression String 30

时间表达式,根据选择的时间类型设置时间表达式。

  • cron:填写标准的cron表达式,支持在线验证。
  • api:无时间表达式。
  • fixed_rate:填写具体固定频率值,单位s。如30表示每隔30s触发一次。
  • second_delay:填写固定延迟多少秒执行一次(1s~60s可选)。
Calendar String 工作日

cron类型可以选择填写自定义日历。

DataOffset Integer 2400

cron类型可以选择时间偏移,单位s。

TimeoutEnable Boolean true

超时报警开关。取值如下:

  • true:开启超时报警开关。
  • false:关闭超时报警开关。
Timeout Long 7200

超时阀值,单位s。

TimeoutKillEnable Boolean true

超时终止本次触发开关。取值如下:

  • true:开启超时终止开关。
  • false:关闭超时终止开关。
FailEnable Boolean true

失败报警开关。取值如下:

  • true:开启失败报警开关。
  • false:关闭失败报警开关。
SendChannel String sms

报警发送形式,目前只支持sms。

ContactInfo.N.UserName String userA

用户名。

ContactInfo.N.UserPhone String 1381111****

用户手机号。

NamespaceSource String schedulerx

特殊第三方才需要填写。

TaskMaxAttempt Integer 0

并行网格任务高级配置,子任务失败重试次数。

TaskAttemptInterval Integer 0

并行网格任务高级配置,子任务失败重试间隔。

返回数据

名称 类型 示例值 描述
Code Integer 200

返回码

Message String job type is java className can not be blank

错误信息,仅出错时返回错误信息。

RequestId String 4F68ABED-AC31-4412-9297-D9A8F0401108

请求唯一ID

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateJob
&ExecuteMode=standalone
&GroupId=testSchedulerx.defaultGroup
&JobId=92583
&Name=helloword
&Namespace=adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
&RegionId=cn-hangzhou
&TimeType=1
&<公共请求参数>

正常返回示例

XML 格式

<UpdateJobResponse>
<RequestId>4F68ABED-AC31-4412-9297-D9A8F0401108</RequestId>
<Message>job type is java className can not be blank</Message>
<Code>200</Code>
<Success>true</Success>

JSON 格式

{
    "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
    "Message": "job type is java className can not be blank",
    "Code": 200,
    "Success": true
}