获取任务列表。
接口说明
在调用该接口前,需要在 POM 文件添加以下依赖:
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-schedulerx2</artifactId>
<version>1.0.5</version>
</dependency>
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
edas:ReadSchedulerxJobQuery |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| GroupId |
string |
是 |
应用 ID,在控制台的应用管理页面中获取。 |
DocTest.Group |
| Namespace |
string |
是 |
命名空间,在控制台的命名空间页面中获取。 |
1a72ecb1-b4cc-400a-a71b-20cdec9b**** |
| NamespaceSource |
string |
否 |
特殊第三方才需要填写。 |
schedulerx |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| JobName |
string |
否 |
任务名称。 |
helloword |
| Status |
string |
否 |
任务状态。
|
1 |
| PageNum |
integer |
否 |
页码。 |
1 |
| PageSize |
integer |
否 |
每页显示的记录数。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
integer |
请求状态码。 |
200 |
| Data |
object |
任务列表信息。 |
|
| Jobs |
array<object> |
任务列表及任务详情。 |
|
|
array<object> |
|||
| AttemptInterval |
integer |
错误重试间隔,单位 s,默认值为 30。 |
30 |
| ClassName |
string |
任务接口类完整路径。 当您的任务是 Java 任务类型时,才有该字段信息。 |
com.alibaba.schedulerx.test.helloworld |
| Content |
string |
python、shell、go 任务类型的脚本代码内容。 |
echo 'hello' |
| Description |
string |
任务描述。 |
Test |
| EndTime |
integer |
任务过期时间 |
1776132529000 |
| ExecuteMode |
string |
任务执行模式,可能出现的结果如下:
|
standalone |
| JarUrl |
string |
JAR 包的 OSS 完整路径。 |
https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.2-SNAPSHOT.jar |
| JobId |
integer |
任务 ID。 |
99341 |
| JobMonitorInfo |
object |
任务监控信息。 |
|
| ContactInfo |
array<object> |
联系人信息。 |
|
|
object |
|||
| Ding |
string |
钉钉群机器人 webhook 地址 |
https://oapi.dingtalk.com/robot/send?access_token=********** |
| UserMail |
string |
用户邮件地址 |
user@mail.com |
| UserName |
string |
用户名称。 |
userA |
| UserPhone |
string |
用户手机号。 |
1381111**** |
| MonitorConfig |
object |
报警开关以及阈值配置。 |
|
| FailEnable |
boolean |
失败报警开关。取值如下:
|
true |
| MissWorkerEnable |
boolean |
是否开启无可用机器报警 |
true |
| SendChannel |
string |
报警发送形式,目前只支持 sms。 |
sms |
| Timeout |
integer |
超时阈值,单位 s,默认 7200。 |
12300 |
| TimeoutEnable |
boolean |
超时报警开关。取值如下:
|
true |
| TimeoutKillEnable |
boolean |
超时终止本次触发开关,默认关闭。
|
false |
| JobType |
string |
任务类型 |
java |
| MapTaskXAttrs |
object |
高级配置,仅限于并行计算、内存网格和网格计算使用。 |
|
| ConsumerSize |
integer |
单机单次触发执行线程数,默认值为 5。 |
5 |
| DispatcherSize |
integer |
子任务分发线程数,默认值为 5。 |
5 |
| PageSize |
integer |
并行任务单次拉取子任务数,默认值为 100。 |
100 |
| QueueSize |
integer |
子任务队列缓存上限,默认值为 10000。 |
10000 |
| TaskAttemptInterval |
integer |
子任务失败重试间隔。 |
0 |
| TaskMaxAttempt |
integer |
子任务失败重试次数。 |
0 |
| MaxAttempt |
integer |
错误最大重试次数,根据业务需求填写,默认值为 0。 |
0 |
| MaxConcurrency |
string |
最大同时运行实例数量,默认值为 1, 即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。 |
1 |
| Name |
string |
任务名。 |
helloworld |
| Parameters |
string |
用户自定义参数,运行时可以获取。 |
test |
| StartTime |
integer |
开始时间戳,单秒毫秒,-1 表示立即开始 |
1789454134000 |
| Status |
integer |
任务状态。取值如下:
|
1 |
| TimeConfig |
object |
时间配置信息 |
|
| Calendar |
string |
cron 类型可以选择填写自定义日历。 |
workday |
| DataOffset |
integer |
cron 类型可以选择时间偏移,单位 s。 |
0 |
| TimeExpression |
string |
时间表达式,目前支持以下几种时间表达类型:
|
0 0/10 * * * ? |
| TimeType |
integer |
时间配置类型,目前支持以下几种时间类型:
|
1 |
| XAttrs |
string |
任务扩展字段 |
{"pageSize":5,"queueSize":10,"consumerSize":5,"dispatcherSize":5,"taskMaxAttempt":0,"taskAttemptInterval":0,"globalConsumerSize":1000,"taskDispatchMode":"push"} |
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
每页数据条数。 |
10 |
| Total |
integer |
总记录数。 |
299 |
| Message |
string |
错误信息,仅出错时返回错误信息。 |
namespace can not find namespace: 1a72ecb1-b4cc-400a-a71b-20cdec9b****, namespaceSource:null |
| RequestId |
string |
请求唯一 ID。 |
71BCC0E3-64B2-4B63-A870-AFB64EBCB58B |
| Success |
boolean |
调用接口是否成功。取值如下:
|
true |
示例
正常返回示例
JSON格式
{
"Code": 200,
"Data": {
"Jobs": [
{
"AttemptInterval": 30,
"ClassName": "com.alibaba.schedulerx.test.helloworld",
"Content": "echo 'hello'",
"Description": "Test",
"EndTime": 1776132529000,
"ExecuteMode": "standalone",
"JarUrl": "https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.2-SNAPSHOT.jar",
"JobId": 99341,
"JobMonitorInfo": {
"ContactInfo": [
{
"Ding": "https://oapi.dingtalk.com/robot/send?access_token=**********",
"UserMail": "user@mail.com",
"UserName": "userA",
"UserPhone": "1381111****"
}
],
"MonitorConfig": {
"FailEnable": true,
"MissWorkerEnable": true,
"SendChannel": "sms",
"Timeout": 12300,
"TimeoutEnable": true,
"TimeoutKillEnable": false
}
},
"JobType": "java",
"MapTaskXAttrs": {
"ConsumerSize": 5,
"DispatcherSize": 5,
"PageSize": 100,
"QueueSize": 10000,
"TaskAttemptInterval": 0,
"TaskMaxAttempt": 0
},
"MaxAttempt": 0,
"MaxConcurrency": "1",
"Name": "helloworld",
"Parameters": "test",
"StartTime": 1789454134000,
"Status": 1,
"TimeConfig": {
"Calendar": "workday",
"DataOffset": 0,
"TimeExpression": "0 0/10 * * * ?",
"TimeType": 1
},
"XAttrs": "{\"pageSize\":5,\"queueSize\":10,\"consumerSize\":5,\"dispatcherSize\":5,\"taskMaxAttempt\":0,\"taskAttemptInterval\":0,\"globalConsumerSize\":1000,\"taskDispatchMode\":\"push\"}"
}
],
"PageNumber": 1,
"PageSize": 10,
"Total": 299
},
"Message": "namespace can not find namespace: 1a72ecb1-b4cc-400a-a71b-20cdec9b****, namespaceSource:null",
"RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58B",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。