查询指定作业的实例列表
功能介绍
根据作业名称精确查询作业实例列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
URI
- URI格式
GET /v2/{project_id}/factory/jobs/{job_name}/instances/detail
?min_plan_time={min_plan_time}&max_plan_time={max_plan_time}&limit={limit}&offset={offset}&status={status}&instance_type={instance_type}&force_success={force_success}&ignore_success={ignore_success}
- 参数说明
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和账号ID。
job_name
是
String
作业名称。
- 如果要查询指定批处理作业的实例列表,job_name就是批处理作业名称;
- 如果要查询实时作业下某个节点关联的子作业,job_name格式为[实时作业名称]_[节点名称]。
min_plan_time
否
Long
返回作业实例开始时间大于min_plan_time的作业实例,单位为毫秒ms,默认设置为查询当天0点,最大可支持查询一个月。
max_plan_time
否
Long
返回作业实例开始时间小于max_plan_time的作业实例,单位为毫秒ms,默认设置为当前时间。
limit
否
int
分页返回结果,指定每页最大记录数。
范围[1,1000]
默认值:10
offset
否
int
分页的起始页,默认值为0。取值范围大于等于0。
status
否
String
实例运行状态:
- waiting:等待运行
- running:运行中
- success:运行成功
- fail:运行失败
- running-exception:运行异常
- skip-by-depend:跳过
- freeze:冻结
- pause:暂停
- manual-stop:取消
默认查全部
instance_type
否
int
作业调度方式:
- 0:正常调度
- 2:手工调度
- 5:补数据
- 6:子作业调度
- 7:单次调度
默认查全部
force_success
否
boolean
status为success的时候使用,true则筛选出强制成功的作业实例
默认值:false
ignore_success
否
boolean
status为success的时候使用,true则筛选出忽略失败的作业实例
默认值:false
请求参数
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
workspace |
否 |
String |
工作空间id。
|
响应参数
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
total |
是 |
Long |
总记录数 |
instances |
是 |
List<Instance> |
作业实例状态,参考表4。 |
参数名 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
job_name |
是 |
String |
作业名称。如果要查询指定批处理作业的实例列表,job_name就是批处理作业名称;如果要查询实时作业下某个节点关联的子作业,job_name格式为[实时作业名称]_[节点名称]。 |
job_id |
否 |
Long |
作业id。 |
job_instance_name |
是 |
String |
作业实例运行时日志记录的实例名称,非作业定义的名称。 |
status |
是 |
String |
状态:
|
plan_time |
是 |
Long |
作业实例计划执行时间 |
start_time |
是 |
Long |
作业实例实际执行开始时间 |
end_time |
否 |
Long |
作业实例实际执行结束时间 |
execute_time |
否 |
Long |
执行耗时,单位:毫秒 |
instance_id |
是 |
Long |
作业实例ID,用于查询作业实例详情。 |
submit_time |
是 |
Long |
作业提交运行时间 |
instance_type |
是 |
int |
作业调度方式:
|
force_success |
否 |
boolean |
作业实例状态筛选为强制成功 默认值:false |
ignore_success |
否 |
boolean |
作业实例状态筛选为忽略失败 默认值:false |
version |
否 |
int |
作业实例版本。 |
请求示例
GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/jobs/job_batch/instances/detail
响应示例
- 成功响应
HTTP状态码 200
{ "total": 2, "instances": [{ "end_time": 1551671598000, "execute_time": 0.3, "force_success": false, "ignore_success": false, "instance_id": 34765, "instance_type": 2, "job_id": 608627, "job_name": "job_batch", "job_instance_name": "job_batch", "plan_time": 1551671580000, "start_time": 1551671580000, "status": "success", "submit_time": 1550910278706, "version": 1 }, { "end_time": 1551671538000, "execute_time": 0.3, "force_success": false, "ignore_success": false, "instance_id": 34764, "instance_type": 5, "job_id": 608627, "job_name": "job_batch", "job_instance_name": "job_batch", "plan_time": 1551671520000, "start_time": 1551671521000, "status": "success", "submit_time": 1550910278706, "version": 1 }] }