AI 助理
文档备案控制台
官方文档
首页 分布式任务调度 任务调度SchedulerX 开发参考 API参考 API目录 任务实例 GetJobInstanceList - 获取指定任务ID的执行实例列表

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

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

根据关键字过滤，返回任务执行的历史记录。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadSchedulerxJobInstanceQuery

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。

cn-hangzhou
Namespace

string

是

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

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

string

否

特殊第三方才需要填写。

schedulerx
GroupId

string

是

应用分组 ID

testSchedulerx.defaultGroup
JobId

integer

否

任务 ID

92583
Status

integer

否

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

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

5
StartTimestamp

integer

否

开始时间（时间戳）。

1684116000000
EndTimestamp

integer

否

结束时间（时间戳）。

1684202400000
PageNum

integer

否

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

1
PageSize

integer

否

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

10

返回参数

名称

类型

描述

示例值

object

Code

integer

返回码

200
Message

string

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

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestId

string

请求唯一 ID

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

boolean

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

  • true：获取任务的执行实例列表成功。

  • false：获取任务的执行实例列表失败。

true
Data

object

instance 列表

JobInstanceDetails

array<object>

任务实例详细信息

object

Status

integer

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

  • 1：等待

  • 3：运行中

  • 4：成功

  • 5：失败

  • 9：拒绝

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

4
Progress

string

实例进度详情

Result

string

实例执行结果

InstanceId

integer

实例 ID

1042499986
TimeType

integer

实例调度时间类型，包含以下几种类型：

  • cron：1

  • fix_rate：3

  • second_delay： 4

  • api：100

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

1
TriggerType

integer

触发类型，包含以下几种触发类型：

  • 1: 定时调度正常触发

  • 2：数据重刷

  • 3：API 触发

  • 4：用户手动点击重跑

  • 5：系统重试（系统异常，如 DB 异常）

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

3
EndTime

string

任务执行结束时间，格式为 yyyy-MM-dd HH:mm:ss。

2020-07-27 11:52:10
StartTime

string

任务执行开始时间，格式为 yyyy-MM-dd HH:mm:ss。

2020-07-27 11:52:10
Executor

string

执行人

A
JobId

integer

任务 ID

92583
ScheduleTime

string

任务调度时间，格式为 yyyy-MM-dd HH:mm:ss。

2020-07-27 11:52:10
DataTime

string

数据时间，格式为 yyyy-MM-dd HH:mm:ss。

2020-07-27 11:52:10
WorkAddr

string

被触发客户端 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"
      }
    ]
  }
}

错误码

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

变更历史

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

上一篇：GetJobInstance - 获取指定任务实例详情下一篇：RetryJobInstance - 重跑任务实例