首页 分布式任务调度 SchedulerX API参考 API目录 任务 GetJobInfo - 获取指定Jobid任务详情

GetJobInfo - 获取指定Jobid任务详情

获取指定Jobid任务详情,通常用来更新任务。

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
JobIdlong

任务ID,在控制台的任务管理页面中获取。

92583
GroupIdstring

应用ID,在控制台的应用管理页面中获取。

testSchedulerx.defaultGroup
Namespacestring

命名空间ID,在控制台的命名空间页面中获取。

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx
RegionIdstring

地域ID。

cn-hangzhou
JobNamestring

任务名称。

simpleJob

返回参数

名称类型描述示例值
object
Codeinteger

返回码。

200
Messagestring

错误信息,仅错误时返回错误信息。

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestIdstring

请求唯一ID。

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

获取任务详情是否成功。取值如下:

  • true:获取任务详情成功。
  • false:获取任务详情失败。
true
Dataobject

指定任务信息。

JobConfigInfoobject

任务配置信息。

JobIdlong

任务ID。

538039
Statusinteger

任务状态。取值如下:

  • 1:启用,可以被正常触发。
  • 0:禁用,不会被触发。
1
Parametersstring

用户自定义参数,运行时可以获取。

test
Descriptionstring

任务描述。

test
ExecuteModestring

任务执行模式,目前包含以下几种任务执行模式:

  • 单机运行:standalone
  • 广播运行:broadcatst
  • 并行计算:parallel
  • 内存网格:grid
  • 网格计算:batch
  • 分片运行:shard
standalone
MaxConcurrencystring

最大同时运行实例数量,默认值为1, 即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。

1
Namestring

任务名称。

helloworld
MaxAttemptinteger

错误最大重试次数,根据业务需求填写,默认值为0。

0
Contentstring

脚本类型任务的脚本。

echo "clear" > /home/admin/edas-container/logs/catalina.out
JarUrlstring

上传到OSS的完整路径。

如果选择JAR包运行,可以将相应JAR包上传到OSS的该路径下。

https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar
ClassNamestring

任务接口类完整路径,仅是Java类型任务时有该字段。

com.alibaba.test.helloword
JobTypestring

任务类型

java
AttemptIntervalinteger

错误重试间隔时间,单位s,默认值为30。

30
MapTaskXAttrsobject

高级配置,仅限于并行计算、内存网格和网格计算使用。

TaskMaxAttemptinteger

子任务失败重试次数。

0
TaskAttemptIntervalinteger

子任务失败重试间隔。

0
ConsumerSizeinteger

单机单次触发执行线程数,默认值为5。

5
QueueSizeinteger

子任务队列缓存上限,默认值为10000。

10000
DispatcherSizeinteger

子任务分发线程数,默认值为5。

5
PageSizeinteger

并行任务单次拉取子任务数,默认值为100。

100
TimeConfigobject

时间配置信息。

Calendarstring

cron类型可以选择填写自定义日历。

工作日
TimeTypeinteger

时间配置类型,目前支持以下几种时间类型:

  • cron:1
  • fix_rate:3
  • second_delay:4
  • one_time :5
  • api:100
1
DataOffsetinteger

cron类型可以选择时间偏移,单位为秒(s)。

0
TimeExpressionstring

时间表达式,目前支持以下几种时间表达类型:

  • api:无时间表达式。
  • fix_rate:具体固定频率值,如30表示每隔30s触发一次。
  • cron:标准的cron表达式。
  • second_delay:固定延迟多少秒执行一次(1s~60s可选)。
0 0/10 * * * ?
JobMonitorInfoobject

任务监控信息。

ContactInfoarray

联系人信息。

object
UserPhonestring

用户手机号。

1381111****
UserNamestring

用户名。

userA
UserMailstring

用户邮件地址。

user@demo.com
Dingstring

钉钉Webhook地址。

https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
MonitorConfigobject

报警开关以及阈值配置。

Timeoutlong

超时阈值,单位为秒(s),默认值为7200。

12300
SendChannelstring

报警发送形式,目前只支持sms。

sms
TimeoutKillEnableboolean

超时终止本次触发开关,默认关闭。

true
TimeoutEnableboolean

超时报警开关。取值如下:

  • true:开启超时报警开关。
  • false:关闭超时报警开关。
true
FailEnableboolean

失败报警开关。取值如下:

  • true:开启失败报警开关。
  • false:关闭失败报警开关。
true
MissWorkerEnableboolean

是否开启无可用机器报警。

true
XAttrsstring

任务扩展字段

{"pageSize":5,"queueSize":10,"consumerSize":5,"dispatcherSize":5,"taskMaxAttempt":0,"taskAttemptInterval":0,"globalConsumerSize":1000,"taskDispatchMode":"push"}

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Data": {
    "JobConfigInfo": {
      "JobId": 538039,
      "Status": 1,
      "Parameters": "test",
      "Description": "test",
      "ExecuteMode": "standalone",
      "MaxConcurrency": "1",
      "Name": "helloworld",
      "MaxAttempt": 0,
      "Content": "echo \"clear\" > /home/admin/edas-container/logs/catalina.out ",
      "JarUrl": "https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar",
      "ClassName": "com.alibaba.test.helloword",
      "JobType": "java",
      "AttemptInterval": 30,
      "MapTaskXAttrs": {
        "TaskMaxAttempt": 0,
        "TaskAttemptInterval": 0,
        "ConsumerSize": 5,
        "QueueSize": 10000,
        "DispatcherSize": 5,
        "PageSize": 100
      },
      "TimeConfig": {
        "Calendar": "工作日",
        "TimeType": 1,
        "DataOffset": 0,
        "TimeExpression": "0 0/10 * * * ?"
      },
      "JobMonitorInfo": {
        "ContactInfo": [
          {
            "UserPhone": "1381111****",
            "UserName": "userA",
            "UserMail": "user@demo.com",
            "Ding": "https://oapi.dingtalk.com/robot/send?access_token=XXXXXX"
          }
        ],
        "MonitorConfig": {
          "Timeout": 12300,
          "SendChannel": "sms",
          "TimeoutKillEnable": true,
          "TimeoutEnable": true,
          "FailEnable": true,
          "MissWorkerEnable": true
        }
      },
      "XAttrs": "{\"pageSize\":5,\"queueSize\":10,\"consumerSize\":5,\"dispatcherSize\":5,\"taskMaxAttempt\":0,\"taskAttemptInterval\":0,\"globalConsumerSize\":1000,\"taskDispatchMode\":\"push\"}"
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-26API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
2022-11-02OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-01-13OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:JobName
阿里云首页 企业级分布式应用服务 相关技术圈