查询作业实例列表
功能介绍
查询作业实例列表。
对于配置了周期调度或事件触发调度的批处理作业，触发一次运行就会生产一个作业实例。如果实时作业里面包含了配置周期调度或事件触发调度节点，可以通过此接口查询节点所关联的子作业的实例列表，参数jobName格式为[实时作业名称]_[节点名称]。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。
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，默认设置为此时的时间点，且开始时间和结束时间的查询范围不超过3天。
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
支持通过作业名进行精确查询。
intervalTypeSubmitted
否
String
作业最新提交版本的调度周期类型，默认全选。
- 分钟调度：minutes
- 小时调度：hours
- 离散小时调度：discreteHour
- 天调度：days
- 周调度：weeks
- 月调度：months
- 季调度：seasons
- 年调度：years
请求参数
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
workspace |
否 |
String |
工作空间id。
|
响应参数
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
total |
是 |
int |
总记录数 |
|
instances |
是 |
List<Instance> |
作业实例状态，参考表4。 |
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
jobName |
是 |
String |
作业名称。如果要查询指定批处理作业的实例列表，jobName就是批处理作业名称；如果要查询实时作业下某个节点关联的子作业，jobName格式为[实时作业名称]_[节点名称]。 |
|
jobId |
否 |
Long |
作业id。 |
|
jobInstanceName |
是 |
String |
作业实例运行时日志记录的实例名称，非作业定义的名称。 |
|
status |
是 |
String |
状态：
|
|
planTime |
是 |
Long |
作业实例计划执行时间 |
|
startTime |
是 |
Long |
作业实例实际执行开始时间 |
|
endTime |
否 |
Long |
作业实例实际执行结束时间 |
|
executeTime |
否 |
Long |
执行耗时，单位：毫秒 |
|
instanceId |
是 |
Long |
作业实例ID，用于查询作业实例详情。 |
|
submitTime |
是 |
Long |
作业提交运行时间 |
|
instanceType |
是 |
int |
作业调度方式：
|
|
intervalSubmitted |
否 |
String |
作业最新提交版本的调度周期。 |
|
forceSuccess |
否 |
boolean |
作业实例状态筛选为强制成功 默认值：false |
|
ignoreSuccess |
否 |
boolean |
作业实例状态筛选为忽略失败 默认值：false |
|
version |
否 |
int |
作业实例版本。 |
|
errorMessage |
否 |
String |
作业实例失败的错误信息。 |
请求示例
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,
"intervalSubmitted": "1 days",
"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,
"intervalSubmitted": "1 days",
"status": "success",
"submitTime": 1550910278706,
"version": 1
}]
}
