首页 分布式任务调度 SchedulerX API参考 API目录 任务 UpdateJob - 更新任务配置信息

UpdateJob - 更新任务配置信息

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

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
Namespacestring

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

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx
GroupIdstring

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

testSchedulerx.defaultGroup
JobIdlong

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

92583
Namestring

任务名。

helloword
Descriptionstring

任务描述。

test
ExecuteModestring

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

  • 单机运行:standalone
  • 广播运行:broadcatst
  • 可视化MapReduce:parallel
  • MapReduce:batch
  • 分片运行:shard
standalone
ClassNamestring

任务接口类完整路径。

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

com.alibaba.test.helloworld
Contentstring

任务类型为Python/Shell/Go/K8s的必填脚本内容。

echo 'hello'
Parametersstring

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

test
MaxConcurrencyinteger

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

1
MaxAttemptinteger

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

0
AttemptIntervalinteger

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

30
PageSizeinteger

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

100
TaskDispatchModestring

并行网格任务高级配置,推模型或者拉模型

枚举值:
  • pullpull
  • pushpush
push
ConsumerSizeinteger

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

5
QueueSizeinteger

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

10000
DispatcherSizeinteger

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

5
TaskMaxAttemptinteger

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

0
TaskAttemptIntervalinteger

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

0
TimeTypeinteger

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

  • cron:1
  • fix_rate:3
  • second_delay:4
  • one_time :5
  • api:100
1
TimeExpressionstring

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

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

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

工作日
DataOffsetinteger

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

2400
Timezonestring

时区

GMT+8
TimeoutEnableboolean

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

  • true:开启超时报警开关。
  • false:关闭超时报警开关。
true
Timeoutlong

超时阈值,单位s。

7200
TimeoutKillEnableboolean

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

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

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

  • true:开启失败报警开关。
  • false:关闭失败报警开关。
true
FailTimesinteger

连续失败报警次数

1
MissWorkerEnableboolean

是否开启无可用机器告警。

  • true:开启无可用机器告警开关。
  • false:关闭无可用机器告警开关。
true
SuccessNoticeEnableboolean

成功通知开关

false
SendChannelstring

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

sms
ContactInfoarray

任务联系人信息。

object
UserPhonestring

用户手机号。

1381111****
UserNamestring

用户名。

userA
UserMailstring

用户邮箱。

test***@***.com
Dingstring

报警联系人钉钉群机器人webhook地址,参考文档:钉钉开发文档

https://oapi.dingtalk.com/robot/send?access_token=**********
说明在调用UpdateJob更新调度任务时,会删除之前对应参数的配置,而非保留。所以,请先调用GetJobInfo,获取目标任务此前的配置,再根据实际情况进行配置。

返回参数

名称类型描述示例值
object
Codeinteger

返回码。

200
Messagestring

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

job type is java className can not be blank
RequestIdstring

请求唯一ID。

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-26API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
2022-09-28API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
阿里云首页 企业级分布式应用服务 相关技术圈