查询作业实例列表
功能介绍
查询作业实例列表。
对于配置了周期调度或事件触发调度的批处理作业,触发一次运行就会生产一个作业实例。如果实时作业里面包含了配置周期调度或事件触发调度节点,可以通过此接口查询节点所关联的子作业的实例列表,参数jobName格式为[实时作业名称]_[节点名称]。
URI
- URI格式
GET /v1/{project_id}/jobs/instances/detail?jobName={jobName}&minPlanTime={minPlanTime}&maxPlanTime={maxPlanTime}&limit={limit}&offset={offset}&status={status}
- 参数说明
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和帐号ID。
jobName
否
String
作业名称。
- 如果要查询指定批处理作业的实例列表,jobName就是批处理作业名称;
- 如果要查询实时作业下某个节点关联的子作业,jobName格式为[实时作业名称]_[节点名称]。
minPlanTime
否
Long
返回计划执行时间大于minPlanTime的作业实例,单位为毫秒ms。
maxPlanTime
否
Long
返回计划执行时间小于maxPlanTime的作业实例,单位为毫秒ms。
limit
否
int
分页返回结果,指定每页最大记录数。
范围[1,1000]
默认值:10
offset
否
int
分页的起始页,默认值为0。取值范围大于等于0。
status
否
String
实例运行状态:
- waiting: 等待运行
- running:运行中
- success: 运行成功
- fail: 运行失败
- running-exception: 运行异常
- pause: 暂停
- manual-stop: 取消
请求消息
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
workspace |
否 |
String |
工作空间id。
|
响应消息
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
total |
是 |
int |
总记录数 |
instances |
是 |
List<Instance> |
作业实例状态,参考表4 |
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
jobName |
是 |
String |
作业名称。如果要查询指定批处理作业的实例列表,jobName就是批处理作业名称;如果要查询实时作业下某个节点关联的子作业,jobName格式为[实时作业名称]_[节点名称]。 |
jobInstanceName |
是 |
String |
作业实例运行时日志记录的实例名称, 非作业定义的名称 |
status |
是 |
String |
状态:
|
planTime |
是 |
Long |
作业实例计划执行时间 |
startTime |
是 |
Long |
作业实例实际执行开始时间 |
endTime |
否 |
Long |
作业实例实际执行结束时间 |
executeTime |
否 |
Long |
执行耗时,单位:毫秒 |
instanceId |
是 |
Long |
作业实例ID |
submitTime |
是 |
Long |
作业提交运行时间 |
示例1
查询批处理作业job_batch的实例列表
- 请求
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/instances/detail?jobName=job_batch
- 成功响应
{ "total": 2, "instances": [{ "endTime": 1551671598000, "executeTime": 0.3, "instanceId": 34765, "jobName": "job_batch", "jobInstanceName": "job_batch", "planTime": 1551671580000, "startTime": 1551671580000, "status": "success", "submitTime": 1550910278706 }, { "endTime": 1551671538000, "executeTime": 0.3, "instanceId": 34764, "jobName": "job_batch", "jobInstanceName": "job_batch", "planTime": 1551671520000, "startTime": 1551671521000, "status": "success", "submitTime": 1550910278706 }] }