UpdateJob_任务调度SchedulerX_API调试-阿里云OpenAPI开发者门户

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。示例值:cn-hangzhou参考取值来源: DescribeRegions
Namespacestring	命名空间 ID，在控制台的命名空间页面中获取。示例值:adcfc35d-e2fe-4fe9-bbaa-20e90ffc****参考取值来源: ListNamespaces CreateNamespace
NamespaceSourcestring	特殊第三方才需要填写。示例值:schedulerx
GroupIdstring	应用 ID，在控制台的应用管理页面中获取。示例值:testSchedulerx.defaultGroup参考取值来源: ListGroups CreateAppGroup
JobIdinteger<int64>	任务 ID，在控制台的任务管理页面中获取。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:92583参考取值来源: ListJobs CreateJob
Namestring	任务名。示例值:helloword
Descriptionstring	任务描述。示例值:test
ExecuteModestring	任务执行模式，目前支持以下几种任务执行模式：展开详情示例值:standalone
ClassNamestring	任务接口类完整路径。展开详情示例值:com.alibaba.test.helloworld
Contentstring	任务类型选择为 python/shell/k8s 时，填写对应的脚本内容。展开详情示例值:echo 'hello'
Parametersstring	用户自定义参数，运行时可以获取。示例值:test
MaxConcurrencyinteger<int32>	最大同时运行实例数量，默认值为 1，即上次触发没有运行结束，不会进行下次触发即使到了运行时刻。示例值:1取值 <= 200
MaxAttemptinteger<int32>	错误最大重试次数，根据业务需求填写。示例值:0
AttemptIntervalinteger<int32>	错误重试间隔时间，单位 s，默认值为 30。示例值:30
PageSizeinteger<int32>	并行网格任务高级配置，单次拉取子任务数，默认值为 100。示例值:100
TaskDispatchModestring	并行网格任务高级配置，推模型或者拉模型示例值:push枚举值:pullpush
ConsumerSizeinteger<int32>	并行网格任务高级配置，单机单次触发执行线程数，默认值为 5。示例值:5
QueueSizeinteger<int32>	并行网格任务高级配置，子任务队列缓存上限，默认值为 10000。示例值:10000
DispatcherSizeinteger<int32>	并行网格任务高级配置，子任务分发线程数，默认值为 5。示例值:5
TaskMaxAttemptinteger<int32>	并行网格任务高级配置，子任务失败重试次数。示例值:0取值 <= 10
TaskAttemptIntervalinteger<int32>	并行网格任务高级配置，子任务失败重试间隔。示例值:0取值 >= 0
TimeTypeinteger<int32>	时间配置类型，目前支持以下几种配置类型：展开详情示例值:1
TimeExpressionstring	时间表达式，根据选择的时间类型设置时间表达式。展开详情示例值:30
Calendarstring	cron 类型可以选择填写自定义日历。示例值:工作日
DataOffsetinteger<int32>	cron 类型可以选择时间偏移，单位 s。示例值:2400
Timezonestring	时区示例值:GMT+8
TimeoutEnableboolean	超时报警开关。取值如下：展开详情示例值:true
Timeoutinteger<int64>	超时阈值，单位 s。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:7200
TimeoutKillEnableboolean	超时终止本次触发开关。取值如下：展开详情示例值:true
FailEnableboolean	失败报警开关。取值如下：展开详情示例值:true
FailTimesinteger<int32>	连续失败报警次数示例值:1
MissWorkerEnableboolean	是否开启无可用机器告警。展开详情示例值:true
SuccessNoticeEnableboolean	成功通知开关示例值:false
SendChannelstring	报警发送形式，目前只支持 sms。示例值:sms枚举值:
ContactInfoarray<object>	任务联系人信息。子级条数 <= 10
XAttrsstring	如果是 k8s 任务类型，需要配置该参数展开详情示例值: {"resource":"shell","fileFormat":"unix","templateType":"customTemplate"}
Templatestring	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
Priorityinteger<int32>	任务优先级。取值如下：展开详情示例值:5

请求说明

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

返回参数

字段名称	字段详情
Codeinteger<int32>	返回码。示例值:200
Messagestring	附加信息，仅出错时返回错误信息。示例值:job type is java className can not be blank
RequestIdstring	请求唯一 ID。示例值:4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean	是否成功。示例值:true

变更历史

	变更时间	变更内容概要	操作
	2025-02-10	新增请求参数Priority
	2024-12-20	变更返回参数
	2024-10-18	变更返回参数
	2023-06-06	新增请求参数XAttrs 新增请求参数Template
	2023-03-30	删除返回参数
	2022-12-26	变更请求参数RegionId
	2022-09-28	变更请求参数Name 变更请求参数ExecuteMode 变更请求参数TimeType 变更请求参数TimeoutEnable 变更请求参数TimeoutKillEnable 变更请求参数FailEnable 变更请求参数MissWorkerEnable 变更请求参数SendChannel