调用GetJobInfo获取指定Jobid任务详情,通常用来更新任务。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetJobInfo |
系统规定参数。取值:GetJobInfo。 |
| JobId | Long | 是 | 92583 |
任务ID,在控制台的任务管理页面中获取。 |
| GroupId | String | 是 | testSchedulerx.defaultGroup |
应用ID,在控制台的应用管理页面中获取。 |
| Namespace | String | 是 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
命名空间ID,在控制台的命名空间页面中获取。 |
| NamespaceSource | String | 否 | schedulerx |
特殊第三方才需要填写。 |
| RegionId | String | 是 | cn-hangzhou |
地域ID。 |
| JobName | String | 否 | simpleJob |
任务名称。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | Integer | 200 |
返回码。 |
| Message | String | jobid: 92583 not match groupId: testSchedulerx.defaultGroup |
错误信息,仅错误时返回错误信息。 |
| RequestId | String | 4F68ABED-AC31-4412-9297-D9A8F0401108 |
请求唯一ID。 |
| Success | Boolean | true |
获取任务详情是否成功。取值如下:
|
| Data | Object |
指定任务信息。 |
|
| JobConfigInfo | Object |
任务配置信息。 |
|
| JobId | Long | 538039 |
任务ID。 |
| Status | Integer | 1 |
任务状态。取值如下:
|
| Parameters | String | test |
用户自定义参数,运行时可以获取。 |
| Description | String | test |
任务描述。 |
| ExecuteMode | String | standalone |
任务执行模式,目前包含以下几种任务执行模式:
|
| MaxConcurrency | String | 1 |
最大同时运行实例数量,默认值为1, 即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。 |
| Name | String | helloworld |
任务名称。 |
| MaxAttempt | Integer | 0 |
错误最大重试次数,根据业务需求填写,默认值为0。 |
| Content | String | echo "clear" > /home/admin/edas-container/logs/catalina.out |
脚本类型任务,具体执行代码。 |
| JarUrl | String | https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar |
上传到OSS的完整路径。 如果选择JAR包运行,可以将相应JAR包上传到OSS的该路径下。 |
| ClassName | String | com.alibaba.test.helloword |
任务接口类完整路径,仅是Java类型任务时有该字段。 |
| AttemptInterval | Integer | 30 |
错误重试间隔时间,单位s,默认值为30。 |
| MapTaskXAttrs | Object |
高级配置,仅限于并行计算、内存网格和网格计算使用。 |
|
| TaskMaxAttempt | Integer | 0 |
子任务失败重试次数。 |
| TaskAttemptInterval | Integer | 0 |
子任务失败重试间隔。 |
| ConsumerSize | Integer | 5 |
单机单次触发执行线程数,默认值为5。 |
| QueueSize | Integer | 10000 |
子任务队列缓存上限,默认值为10000。 |
| DispatcherSize | Integer | 5 |
子任务分发线程数,默认值为5。 |
| PageSize | Integer | 100 |
并行任务单次拉取子任务数,默认值为100。 |
| TimeConfig | Object |
时间配置信息。 |
|
| Calendar | String | 工作日 |
cron类型可以选择填写自定义日历。 |
| TimeType | Integer | 1 |
时间配置类型,目前支持以下几种时间类型:
|
| DataOffset | Integer | 0 |
cron类型可以选择时间偏移,单位为秒(s)。 |
| TimeExpression | String | 0 0/10 * * * ? |
时间表达式,目前支持以下几种时间表达类型:
|
| JobMonitorInfo | Object |
任务监控信息。 |
|
| ContactInfo | Array of ContactInfo |
联系人信息。 |
|
| UserPhone | String | 1381111**** |
用户手机号。 |
| UserName | String | userA |
用户名。 |
| UserMail | String | user@demo.com |
用户邮件地址。 |
| Ding | String | https://oapi.dingtalk.com/robot/send?access_token=XXXXXX |
钉钉Webhook地址。 |
| MonitorConfig | Object |
报警开关以及阈值配置。 |
|
| Timeout | Long | 12300 |
超时阈值,单位为秒(s),默认值为7200。 |
| SendChannel | String | sms |
报警发送形式,目前只支持sms。 |
| TimeoutKillEnable | Boolean | true |
超时终止本次触发开关,默认关闭。 |
| TimeoutEnable | Boolean | true |
超时报警开关。取值如下:
|
| FailEnable | Boolean | true |
失败报警开关。取值如下:
|
| MissWorkerEnable | Boolean | true |
是否开启无可用机器报警。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetJobInfo
&JobId=92583
&GroupId=testSchedulerx.defaultGroup****
&Namespace=adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
&NamespaceSource=schedulerx
&RegionId=cn-hangzhou
&JobName=simpleJob
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetJobInfoResponse>
<RequestId>4F68ABED-AC31-4412-9297-D9A8F0401108</RequestId>
<Message>jobid: 92583 not match groupId: testSchedulerx.defaultGroup</Message>
<Data>
<JobConfigInfo>
<Status>1</Status>
<MaxAttempt>0</MaxAttempt>
<Description>test</Description>
<Parameters>test</Parameters>
<JarUrl>https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar</JarUrl>
<MaxConcurrency>1</MaxConcurrency>
<TimeConfig>
<TaskAttemptInterval>0</TaskAttemptInterval>
<QueueSize>10000</QueueSize>
<PageSize>100</PageSize>
<DispatcherSize>5</DispatcherSize>
<TaskMaxAttempt>0</TaskMaxAttempt>
<Calendar>工作日</Calendar>
<TimeExpression>0 0/10 * * * ?</TimeExpression>
<ContactInfo>
<UserName>userA</UserName>
<UserPhone>1381111****</UserPhone>
</ContactInfo>
<ConsumerSize>5</ConsumerSize>
<DataOffset>0</DataOffset>
<TimeType>1</TimeType>
<MonitorConfig>
<TimeoutEnable>true</TimeoutEnable>
<Timeout>12300</Timeout>
<FailEnable>true</FailEnable>
<SendChannel>sms</SendChannel>
<TimeoutKillEnable>true</TimeoutKillEnable>
</MonitorConfig>
</TimeConfig>
<Name>helloworld</Name>
<MapTaskXAttrs>
<TaskAttemptInterval>0</TaskAttemptInterval>
<QueueSize>10000</QueueSize>
<PageSize>100</PageSize>
<DispatcherSize>5</DispatcherSize>
<TaskMaxAttempt>0</TaskMaxAttempt>
<Calendar>工作日</Calendar>
<TimeExpression>0 0/10 * * * ?</TimeExpression>
<ContactInfo>
<UserName>userA</UserName>
<UserPhone>1381111****</UserPhone>
</ContactInfo>
<ConsumerSize>5</ConsumerSize>
<DataOffset>0</DataOffset>
<TimeType>1</TimeType>
<MonitorConfig>
<TimeoutEnable>true</TimeoutEnable>
<Timeout>12300</Timeout>
<FailEnable>true</FailEnable>
<SendChannel>sms</SendChannel>
<TimeoutKillEnable>true</TimeoutKillEnable>
</MonitorConfig>
</MapTaskXAttrs>
<JobMonitorInfo>
<TaskAttemptInterval>0</TaskAttemptInterval>
<QueueSize>10000</QueueSize>
<PageSize>100</PageSize>
<DispatcherSize>5</DispatcherSize>
<TaskMaxAttempt>0</TaskMaxAttempt>
<Calendar>工作日</Calendar>
<TimeExpression>0 0/10 * * * ?</TimeExpression>
<ContactInfo>
<UserName>userA</UserName>
<UserPhone>1381111****</UserPhone>
</ContactInfo>
<ConsumerSize>5</ConsumerSize>
<DataOffset>0</DataOffset>
<TimeType>1</TimeType>
<MonitorConfig>
<TimeoutEnable>true</TimeoutEnable>
<Timeout>12300</Timeout>
<FailEnable>true</FailEnable>
<SendChannel>sms</SendChannel>
<TimeoutKillEnable>true</TimeoutKillEnable>
</MonitorConfig>
</JobMonitorInfo>
<Content>echo "clear" &gt; /home/admin/edas-container/logs/catalina.out</Content>
<ClassName>com.alibaba.test.helloword</ClassName>
<AttemptInterval>30</AttemptInterval>
<ExecuteMode>standalone</ExecuteMode>
</JobConfigInfo>
</Data>
<Code>200</Code>
<Success>true</Success>
</GetJobInfoResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Message" : "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
"Data" : {
"JobConfigInfo" : {
"Status" : 1,
"MaxAttempt" : 0,
"Description" : "test",
"Parameters" : "test",
"JarUrl" : "https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar",
"MaxConcurrency" : 1,
"TimeConfig" : {
"TaskAttemptInterval" : 0,
"QueueSize" : 10000,
"PageSize" : 100,
"DispatcherSize" : 5,
"TaskMaxAttempt" : 0,
"Calendar" : "工作日",
"TimeExpression" : "0 0/10 * * * ?",
"ContactInfo" : {
"UserName" : "userA",
"UserPhone" : "1381111****"
},
"ConsumerSize" : 5,
"DataOffset" : 0,
"TimeType" : 1,
"MonitorConfig" : {
"TimeoutEnable" : true,
"Timeout" : 12300,
"FailEnable" : true,
"SendChannel" : "sms",
"TimeoutKillEnable" : true
}
},
"Name" : "helloworld",
"MapTaskXAttrs" : {
"TaskAttemptInterval" : 0,
"QueueSize" : 10000,
"PageSize" : 100,
"DispatcherSize" : 5,
"TaskMaxAttempt" : 0,
"Calendar" : "工作日",
"TimeExpression" : "0 0/10 * * * ?",
"ContactInfo" : {
"UserName" : "userA",
"UserPhone" : "1381111****"
},
"ConsumerSize" : 5,
"DataOffset" : 0,
"TimeType" : 1,
"MonitorConfig" : {
"TimeoutEnable" : true,
"Timeout" : 12300,
"FailEnable" : true,
"SendChannel" : "sms",
"TimeoutKillEnable" : true
}
},
"JobMonitorInfo" : {
"TaskAttemptInterval" : 0,
"QueueSize" : 10000,
"PageSize" : 100,
"DispatcherSize" : 5,
"TaskMaxAttempt" : 0,
"Calendar" : "工作日",
"TimeExpression" : "0 0/10 * * * ?",
"ContactInfo" : {
"UserName" : "userA",
"UserPhone" : "1381111****"
},
"ConsumerSize" : 5,
"DataOffset" : 0,
"TimeType" : 1,
"MonitorConfig" : {
"TimeoutEnable" : true,
"Timeout" : 12300,
"FailEnable" : true,
"SendChannel" : "sms",
"TimeoutKillEnable" : true
}
},
"Content" : "echo \"clear\" &gt; /home/admin/edas-container/logs/catalina.out",
"ClassName" : "com.alibaba.test.helloword",
"AttemptInterval" : 30,
"ExecuteMode" : "standalone"
}
},
"Code" : 200,
"Success" : true
}