更新时间:2024-11-22 GMT+08:00

查询作业实例列表

功能介绍

查询作业实例列表。

对于配置了周期调度或事件触发调度的批处理作业,触发一次运行就会生产一个作业实例。如果实时作业里面包含了配置周期调度或事件触发调度节点,可以通过此接口查询节点所关联的子作业的实例列表,参数jobName格式为[实时作业名称]_[节点名称]。

URI

  • URI格式

    GET /v1/{project_id}/jobs/instances/detail?jobName={jobName}&minPlanTime={minPlanTime}&maxPlanTime={maxPlanTime}&limit={limit}&offset={offset}&status={status}&instanceType={instanceType}&preciseQuery={preciseQuery}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    jobName

    String

    作业名称。

    • 如果要查询指定批处理作业的实例列表,jobName就是批处理作业名称;
    • 如果要查询实时作业下某个节点关联的子作业,jobName格式为[实时作业名称]_[节点名称]。

    minPlanTime

    Long

    返回作业实例开始时间大于minPlanTime的作业实例,单位为毫秒ms,默认设置为查询当天0点。

    maxPlanTime

    Long

    返回作业实例开始时间小于maxPlanTime的作业实例,单位为毫秒ms。

    limit

    int

    分页返回结果,指定每页最大记录数。

    范围[1,1000]

    默认值:10

    offset

    int

    分页的起始页,默认值为0。取值范围大于等于0。

    status

    String

    实例运行状态:

    • waiting:等待运行
    • running:运行中
    • success:运行成功
    • fail:运行失败
    • running-exception:运行异常
    • pause:暂停
    • manual-stop:取消

    instanceType

    int

    作业调度方式:

    • 0:正常调度
    • 2:手工调度
    • 5:补数据
    • 6:子作业调度
    • 7:单次调度

    preciseQuery

    boolean

    支持通过作业名进行精确查询。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

响应参数

表3 参数说明

参数名

是否必选

参数类型

说明

total

int

总记录数

instances

List<Instance>

作业实例状态,参考表4

表4 Instance属性说明

参数名

是否必选

参数类型

说明

jobName

String

作业名称。如果要查询指定批处理作业的实例列表,jobName就是批处理作业名称;如果要查询实时作业下某个节点关联的子作业,jobName格式为[实时作业名称]_[节点名称]。

jobId

Long

作业id。

jobInstanceName

String

作业实例运行时日志记录的实例名称,非作业定义的名称。

status

String

状态:

  • waiting:等待运行
  • running:运行中
  • success: 运行成功
  • fail:运行失败
  • running-exception :运行异常
  • pause :暂停
  • manual-stop :取消

planTime

Long

作业实例计划执行时间

startTime

Long

作业实例实际执行开始时间

endTime

Long

作业实例实际执行结束时间

executeTime

Long

执行耗时,单位:毫秒

instanceId

Long

作业实例ID,用于查询作业实例详情。

submitTime

Long

作业提交运行时间

instanceType

int

作业调度方式:

  • 0:正常调度
  • 2:手工调度
  • 5:补数据
  • 6:子作业调度
  • 7:单次调度

forceSuccess

boolean

作业实例状态筛选为强制成功

默认值:false

ignoreSuccess

boolean

作业实例状态筛选为忽略失败

默认值:false

version

int

作业实例版本。

请求示例

查询批处理作业job_batch的实例列表
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/instances/detail?jobName=job_batch

响应示例

成功响应
{
	"total": 2,
	"instances": [{
		"endTime": 1551671598000,
		"executeTime": 0.3,
		"forceSuccess": false,
		"ignoreSuccess": false,
		"instanceId": 34765,
		"instanceType": 2,
		"jobId": 608627,
		"jobName": "job_batch",
		"jobInstanceName": "job_batch",
		"planTime": 1551671580000,
		"startTime": 1551671580000,
		"status": "success",
		"submitTime": 1550910278706,
		"version": 1
	},
	{
		"endTime": 1551671538000,
		"executeTime": 0.3,
		"forceSuccess": false,
		"ignoreSuccess": false,
		"instanceId": 34764,
		"instanceType": 5,
		"jobId": 608627,
		"jobName": "job_batch",
		"jobInstanceName": "job_batch",
		"planTime": 1551671520000,
		"startTime": 1551671521000,
		"status": "success",
		"submitTime": 1550910278706,
		"version": 1
	}]
}