GetJobInstance - 获取指定任务实例详情
返回任务实例的信息，可以查看任务实例的状态和进度。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
edas:ReadSchedulerxJobInstanceQuery |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
区域 ID |
cn-hangzhou |
| Namespace |
string |
是 |
命名空间 id，在控制台的命名空间页面中获取。 |
adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| GroupId |
string |
是 |
应用 id，在控制台的应用管理页面中获取。 |
testSchedulerx.defaultGroup |
| JobId |
integer |
是 |
任务 ID，在控制台的任务管理页面中获取。 |
92583 |
| JobInstanceId |
integer |
是 |
任务实例 ID |
1685883418 |
| NamespaceSource |
string |
否 |
特殊第三方才需要填写。 |
schedulerx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
integer |
返回码 |
200 |
| Message |
string |
错误信息 |
jobId=xxx is not existed |
| RequestId |
string |
请求唯一 id |
4F68ABED-AC31-4412-9297-D9A8F0401108 |
| Success |
boolean |
获取任务实例详情是否成功。取值如下：
|
true |
| Data |
object |
instance 信息 |
|
| JobInstanceDetail |
object |
任务实例详细信息 |
|
| Status |
integer |
实例状态。包含以下几种状态：
对应枚举类： com.alibaba.schedulerx.common.domain.InstanceStatus |
4 |
| Progress |
string |
实例进度详情 |
{"taskProgress":[{"name":"MAP_TASK_ROOT","total":1,"pulled":1,"running":0,"success":0,"failed":0}],"workerProgress":[{"workerAddr":"11.122.241.245:34865","total":1,"pulled":1,"running":0,"success":0,"failed":0}]} |
| Result |
string |
实例执行结果 |
{'TotalSize': 31, 'CurrentPage': 5, 'PageSize': 10} |
| InstanceId |
integer |
实例 id |
1189853849 |
| TimeType |
integer |
实例调度时间类型，包含以下几种时间类型：
对应枚举类：com.alibaba.schedulerx.common.domain.TimeType |
1 |
| TriggerType |
integer |
触发类型，包含以下几种触发类型：
对应枚举类：com.alibaba.schedulerx.common.domain.TriggerType |
1 |
| EndTime |
string |
任务执行结束时间 |
2020-07-27 11:52:10 |
| StartTime |
string |
任务执行开始时间 |
2020-07-27 11:52:10 |
| Executor |
string |
执行人 |
John Smith |
| JobId |
integer |
任务 id |
92583 |
| ScheduleTime |
string |
计划调度时间 |
2020-07-27 11:52:10 |
| DataTime |
string |
任务数据时间 |
2020-07-27 11:52:10 |
| WorkAddr |
string |
被触发客户端 ip:port |
192.168.0.0:16 |
| Parameters |
string |
任务运行实例参数信息。 |
{\"alertId\":11111} |
| JobName |
string |
任务名称 |
ManualJob |
| TraceId |
string |
调用链 ID，可用于精确查询调用信息。 |
210e845016596663430048015d0a2c |
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "jobId=xxx is not existed",
"RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Success": true,
"Data": {
"JobInstanceDetail": {
"Status": 4,
"Progress": "{\"taskProgress\":[{\"name\":\"MAP_TASK_ROOT\",\"total\":1,\"pulled\":1,\"running\":0,\"success\":0,\"failed\":0}],\"workerProgress\":[{\"workerAddr\":\"11.122.241.245:34865\",\"total\":1,\"pulled\":1,\"running\":0,\"success\":0,\"failed\":0}]}",
"Result": "{'TotalSize': 31, 'CurrentPage': 5, 'PageSize': 10}",
"InstanceId": 1189853849,
"TimeType": 1,
"TriggerType": 1,
"EndTime": "2020-07-27 11:52:10",
"StartTime": "2020-07-27 11:52:10",
"Executor": "John Smith",
"JobId": 92583,
"ScheduleTime": "2020-07-27 11:52:10",
"DataTime": "2020-07-27 11:52:10",
"WorkAddr": "192.168.0.0:16",
"Parameters": "{\\\"alertId\\\":11111}",
"JobName": "ManualJob",
"TraceId": "210e845016596663430048015d0a2c"
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。