AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

GetJobInfo - 获取指定Jobid任务详情

更新时间：
复制为 MD 格式
我的收藏

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadSchedulerxJobQuery

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
JobId

integer

是

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

92583
GroupId

string

是

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

testSchedulerx.defaultGroup
Namespace

string

是

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

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

string

否

特殊第三方才需要填写。

schedulerx
RegionId

string

是

地域 ID。

cn-hangzhou
JobName

string

否

任务名称。

simpleJob

返回参数

名称

类型

描述

示例值

object

Code

integer

返回码。

200
Message

string

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

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestId

string

请求唯一 ID。

4F68ABED-AC31-4412-9297-D9A8F0401108
Success

boolean

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

  • true：获取任务详情成功。

  • false：获取任务详情失败。

true
Data

object

指定任务信息。

JobConfigInfo

object

任务配置信息。

JobId

integer

任务 ID。

538039
Status

integer

任务状态。取值如下：

  • 1：启用，可以被正常触发。

  • 0：禁用，不会被触发。

1
Parameters

string

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

test
Description

string

任务描述。

test
ExecuteMode

string

任务执行模式，目前包含以下几种任务执行模式：

  • 单机运行：standalone

  • 广播运行：broadcatst

  • 并行计算：parallel

  • 内存网格：grid

  • 网格计算：batch

  • 分片运行：shard

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

上传到 OSS 的完整路径。

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

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

string

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

com.alibaba.test.helloword
JobType

string

任务类型

java
AttemptInterval

integer

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

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 类型可以选择填写自定义日历。

workday
TimeType

integer

时间配置类型，目前支持以下几种时间类型：

  • cron：1

  • fix_rate：3

  • second_delay：4

  • one_time ：5

  • api：100

1
DataOffset

integer

cron 类型可以选择时间偏移，单位为秒（s）。

0
TimeExpression

string

时间表达式，目前支持以下几种时间表达类型：

  • api：无时间表达式。

  • fix_rate：具体固定频率值，如 30 表示每隔 30s 触发一次。

  • cron：标准的 cron 表达式。

  • second_delay：固定延迟多少秒执行一次（1s~60s 可选）。

0 0/10 * * * ?
JobMonitorInfo

object

任务监控信息。

ContactInfo

array<object>

联系人信息。

object

UserPhone

string

用户手机号。

1381111****
UserName

string

用户名。

userA
UserMail

string

用户邮件地址。

user@demo.com
Ding

string

钉钉 Webhook 地址。

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

object

报警开关以及阈值配置。

Timeout

integer

超时阈值，单位为秒（s），默认值为 7200。

12300
SendChannel

string

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

sms
TimeoutKillEnable

boolean

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

true
TimeoutEnable

boolean

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

  • true：开启超时报警开关。

  • false：关闭超时报警开关。

true
FailEnable

boolean

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

  • true：开启失败报警开关。

  • false：关闭失败报警开关。

true
MissWorkerEnable

boolean

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

true
XAttrs

string

任务扩展字段

{"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": "workday",
        "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\"}"
    }
  }
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：EnableJob - 启用指定任务下一篇：ListJobs - 获取任务列表