调用UpdateJob更新任务配置信息_分布式任务调度(SchedulerX)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
Namespace	string	是	命名空间 ID，在控制台的命名空间页面中获取。	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	否	特殊第三方才需要填写。	schedulerx
GroupId	string	是	应用 ID，在控制台的应用管理页面中获取。	testSchedulerx.defaultGroup
JobId	long	是	任务 ID，在控制台的任务管理页面中获取。	92583
Name	string	否	任务名。	helloword
Description	string	否	任务描述。	test
ExecuteMode	string	否	任务执行模式，目前支持以下几种任务执行模式：单机运行：standalone 广播运行：broadcatst 可视化 MapReduce：parallel MapReduce：batch 分片运行：shard	standalone
ClassName	string	否	任务接口类完整路径。是 Java 任务类型时，才有该字段且必须填写完整路径。	com.alibaba.test.helloworld
Content	string	否	任务类型为 Python/Shell/Go/K8s 的必填脚本内容。	echo 'hello'
Parameters	string	否	用户自定义参数，运行时可以获取。	test
MaxConcurrency	integer	否	最大同时运行实例数量，默认值为 1，即上次触发没有运行结束，不会进行下次触发即使到了运行时刻。	1
MaxAttempt	integer	否	错误最大重试次数，根据业务需求填写。	0
AttemptInterval	integer	否	错误重试间隔时间，单位 s，默认值为 30。	30
PageSize	integer	否	并行网格任务高级配置，单次拉取子任务数，默认值为 100。	100
TaskDispatchMode	string	否	并行网格任务高级配置，推模型或者拉模型枚举值： pull：pull。 push：push。	push
ConsumerSize	integer	否	并行网格任务高级配置，单机单次触发执行线程数，默认值为 5。	5
QueueSize	integer	否	并行网格任务高级配置，子任务队列缓存上限，默认值为 10000。	10000
DispatcherSize	integer	否	并行网格任务高级配置，子任务分发线程数，默认值为 5。	5
TaskMaxAttempt	integer	否	并行网格任务高级配置，子任务失败重试次数。	0
TaskAttemptInterval	integer	否	并行网格任务高级配置，子任务失败重试间隔。	0
TimeType	integer	否	时间配置类型，目前支持以下几种配置类型： cron：1 fix_rate：3 second_delay：4 one_time ：5 api：100	1
TimeExpression	string	否	时间表达式，根据选择的时间类型设置时间表达式。 cron：填写标准的 cron 表达式，支持在线验证。 api：无时间表达式。 fixed_rate：填写具体固定频率值，单位 s。如 30 表示每隔 30s 触发一次。 second_delay：填写固定延迟多少秒执行一次（1s~60s 可选）。	30
Calendar	string	否	cron 类型可以选择填写自定义日历。	工作日
DataOffset	integer	否	cron 类型可以选择时间偏移，单位 s。	2400
Timezone	string	否	时区	GMT+8
TimeoutEnable	boolean	否	超时报警开关。取值如下： true：开启超时报警开关。 false：关闭超时报警开关。	true
Timeout	long	否	超时阈值，单位 s。	7200
TimeoutKillEnable	boolean	否	超时终止本次触发开关。取值如下： true：开启超时终止开关。 false：关闭超时终止开关。	true
FailEnable	boolean	否	失败报警开关。取值如下： true：开启失败报警开关。 false：关闭失败报警开关。	true
FailTimes	integer	否	连续失败报警次数	1
MissWorkerEnable	boolean	否	是否开启无可用机器告警。 true：开启无可用机器告警开关。 false：关闭无可用机器告警开关。	true
SuccessNoticeEnable	boolean	否	成功通知开关	false
SendChannel	string	否	报警发送形式，目前只支持 sms。	sms
ContactInfo	array<object>	否	任务联系人信息。
	object	否
UserPhone	string	否	用户手机号。	1381111****
UserName	string	否	用户名。	userA
UserMail	string	否	用户邮箱。	test*@*.com
Ding	string	否	报警联系人钉钉群机器人 webhook 地址，参考文档：钉钉开发文档。	https://oapi.dingtalk.com/robot/send?access_token=**********
XAttrs	string	否	如果是 k8s 任务类型，需要配置该参数 Job 任务：{"resource":"job"} Shell 任务：{"image":"busybox","resource":"shell"}	{"resource":"shell","fileFormat":"unix","templateType":"customTemplate"}
Template	string	否	k8s 任务类型自定义任务模版	apiVersion: v1 kind: Pod metadata: name: schedulerx-node-{JOB_ID} namespace: {NAMESPACE} spec: containers: - name: node-job image: node:16 imagePullPolicy: IfNotPresent volumeMounts: - name: script-node mountPath: script/node command: ["node", "script/node/node-{JOB_ID}.js"] volumes: - name: script-node configMap: name: schedulerx-configmap items: - key: schedulerx-node-{JOB_ID} path: node-{JOB_ID}.js restartPolicy: Never

说明在调用 UpdateJob 更新调度任务时，会删除之前对应参数的配置，而非保留。所以，请先调用 GetJobInfo ，获取目标任务此前的配置，再根据实际情况进行配置。

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回码。	200
Message	string	附加信息，仅出错时返回错误信息。	job type is java className can not be blank
RequestId	string	请求唯一 ID。	4F68ABED-AC31-4412-9297-D9A8F0401108
Success	boolean	是否成功。	true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "job type is java className can not be blank",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-06-07	OpenAPI 入参发生变更	查看变更详情
2023-03-30	API 内部配置变更，不影响调用	查看变更详情
2022-12-26	API 内部配置变更，不影响调用	查看变更详情
2022-09-28	API 内部配置变更，不影响调用	查看变更详情