文档

GetJobInstanceList - 获取指定任务ID的执行实例列表

更新时间:
一键部署

只返回最近10条运行实例列表。

调试

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

授权信息

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

请求参数

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

地域 ID。

cn-hangzhou
Namespacestring

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

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

特殊第三方才需要填写。

schedulerx
GroupIdstring

应用分组 ID

testSchedulerx.defaultGroup
JobIdlong

任务 ID

92583
Statusinteger

实例状态。包含以下几种状态:

1:等待 3:运行中 4:成功 5:失败 9:拒绝 对应枚举类: com.alibaba.schedulerx.common.domain.InstanceStatus

5
StartTimestamplong

开始时间(时间戳)。

1684116000000
EndTimestamplong

结束时间(时间戳)。

1684202400000
PageNuminteger

分页获取数据,分页号,默认是 1

1
PageSizeinteger

分页获取数据,分页大小,默认是 10

10

返回参数

名称类型描述示例值
object
Codeinteger

返回码

200
Messagestring

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

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestIdstring

请求唯一 ID

704A2A61-3681-5568-92F7-2DFCC53F33D1
Successboolean

获取任务的执行实例列表是否成功。取值如下:

  • true:获取任务的执行实例列表成功。
  • false:获取任务的执行实例列表失败。
true
Dataobject

instance 列表

JobInstanceDetailsobject []

任务实例详细信息

Statusinteger

实例状态。包含以下几种状态:

  • 1:等待
  • 3:运行中
  • 4:成功
  • 5:失败
  • 9:拒绝

对应枚举类: com.alibaba.schedulerx.common.domain.InstanceStatus

4
Progressstring

实例进度详情

Resultstring

实例执行结果

InstanceIdlong

实例 ID

1042499986
TimeTypeinteger

实例调度时间类型,包含以下几种类型:

  • cron:1
  • fix_rate:3
  • second_delay: 4
  • api:100

对应枚举类:com.alibaba.schedulerx.common.domain.TimeType

1
TriggerTypeinteger

触发类型,包含以下几种触发类型:

  • 1: 定时调度正常触发
  • 2:数据重刷
  • 3:API 触发
  • 4:用户手动点击重跑
  • 5:系统重试(系统异常,如 DB 异常)

对应枚举类:com.alibaba.schedulerx.common.domain.TriggerType

3
EndTimestring

任务执行结束时间

2020-07-27 11:52:10
StartTimestring

任务执行开始时间

2020-07-27 11:52:10
Executorstring

执行人

A
JobIdlong

任务 ID

92583
ScheduleTimestring

任务调度时间

2020-07-27 11:52:10
DataTimestring

数据时间

2020-07-27 11:52:10
WorkAddrstring

被触发客户端 ip:port

192.168.0.0:16

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "704A2A61-3681-5568-92F7-2DFCC53F33D1",
  "Success": true,
  "Data": {
    "JobInstanceDetails": [
      {
        "Status": 4,
        "Progress": "",
        "Result": "",
        "InstanceId": 1042499986,
        "TimeType": 1,
        "TriggerType": 3,
        "EndTime": "2020-07-27 11:52:10",
        "StartTime": "2020-07-27 11:52:10",
        "Executor": "A",
        "JobId": 92583,
        "ScheduleTime": "2020-07-27 11:52:10",
        "DataTime": "2020-07-27 11:52:10",
        "WorkAddr": "192.168.0.0:16"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Status
    新增入参:StartTimestamp
    新增入参:EndTimestamp
  • 本页导读 (1)