调用UpdateJob接口更新任务配置信息。默认先调用获取任务找到对应字段进行修改。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateJob |
系统规定参数。取值:UpdateJob。 |
Name | String | 是 | helloword |
任务名。 |
Description | String | 否 | test |
任务描述。 |
ExecuteMode | String | 是 | standalone |
任务执行模式,目前支持以下几种任务执行模式:
|
Content | String | 否 | echo 'hello' |
任务类型为python、shell、go的必填脚本内容。 |
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。 |
TimeType | Integer | 是 | 1 |
时间配置类型,目前支持以下几种配置类型:
|
TimeExpression | String | 否 | 30 |
时间表达式,根据选择的时间类型设置时间表达式。
|
Calendar | String | 否 | 工作日 |
cron类型可以选择填写自定义日历。 |
DataOffset | Integer | 否 | 2400 |
cron类型可以选择时间偏移,单位s。 |
TimeoutEnable | Boolean | 否 | true |
超时报警开关。取值如下:
|
Timeout | Long | 否 | 7200 |
超时阈值,单位s。 |
TimeoutKillEnable | Boolean | 否 | true |
超时终止本次触发开关。取值如下:
|
FailEnable | Boolean | 否 | true |
失败报警开关。取值如下:
|
MissWorkerEnable | Boolean | 否 | true |
是否开启无可用机器告警。
|
SendChannel | String | 否 | sms |
报警发送形式,目前只支持sms。 |
Namespace | String | 是 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
命名空间ID,在控制台的命名空间页面中获取。 |
GroupId | String | 是 | testSchedulerx.defaultGroup |
应用ID,在控制台的应用管理页面中获取。 |
NamespaceSource | String | 否 | schedulerx |
特殊第三方才需要填写。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
JobId | Long | 是 | 92583 |
任务ID,在控制台的任务管理页面中获取。 |
TaskMaxAttempt | Integer | 否 | 0 |
并行网格任务高级配置,子任务失败重试次数。 |
TaskAttemptInterval | Integer | 否 | 0 |
并行网格任务高级配置,子任务失败重试间隔。 |
ContactInfo.N.UserPhone | String | 否 | 1381111**** |
用户手机号。 |
ContactInfo.N.UserName | String | 否 | userA |
用户名。 |
ContactInfo.N.UserMail | String | 否 | test***@***.com |
用户邮箱。 |
ContactInfo.N.Ding | String | 否 | 67***798 |
用户钉钉号。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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
&Name=helloword
&Description=test
&ExecuteMode=standalone
&Content=echo 'hello'
&Parameters=test
&MaxConcurrency=1
&MaxAttempt=0
&AttemptInterval=30
&ClassName=com.alibaba.test.helloworld
&JarUrl=暂不支持,不用填写
&PageSize=100
&ConsumerSize=5
&QueueSize=10000
&DispatcherSize=5
&TimeType=1
&TimeExpression=30
&Calendar=工作日
&DataOffset=2400
&TimeoutEnable=true
&Timeout=7200
&TimeoutKillEnable=true
&FailEnable=true
&MissWorkerEnable=true
&SendChannel=sms
&Namespace=adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
&GroupId=testSchedulerx.defaultGroup
&NamespaceSource=schedulerx
&RegionId=cn-hangzhou
&JobId=92583
&TaskMaxAttempt=0
&TaskAttemptInterval=0
&ContactInfo=[{"UserPhone":"1381111****","UserName":"userA","UserMail":"test***@***.com","Ding":"67***798"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateJobResponse>
<Code>200</Code>
<Message>job type is java className can not be blank</Message>
<RequestId>4F68ABED-AC31-4412-9297-D9A8F0401108</RequestId>
<Success>true</Success>
</UpdateJobResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : 200,
"Message" : "job type is java className can not be blank",
"RequestId" : "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Success" : true
}