文档

GetJobInstance - 获取指定任务实例详情

更新时间:
一键部署

返回任务实例的信息,可以查看任务实例的状态和进度。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

区域ID

cn-hangzhou
Namespacestring

命名空间id,在控制台的命名空间页面中获取。

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
GroupIdstring

应用id,在控制台的应用管理页面中获取。

testSchedulerx.defaultGroup
JobIdlong

任务ID,在控制台的任务管理页面中获取。

92583
JobInstanceIdlong

任务实例ID

1685883418
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx

返回参数

名称类型描述示例值
object
Codeinteger

返回码

200
Messagestring

错误信息

jobId=xxx is not existed
RequestIdstring

请求唯一id

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

获取任务实例详情是否成功。取值如下:

  • true:获取任务实例详情成功。
  • false:获取任务实例详情失败。
true
Dataobject

instance信息

JobInstanceDetailobject

任务实例详细信息

Statusinteger

实例状态。包含以下几种状态:

  • 1:等待
  • 3:运行中
  • 4:成功
  • 5:失败
  • 9:拒绝

对应枚举类: com.alibaba.schedulerx.common.domain.InstanceStatus

4
Progressstring

实例进度详情

{"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}]}
Resultstring

实例执行结果

{'TotalSize': 31, 'CurrentPage': 5, 'PageSize': 10}
InstanceIdlong

实例id

1189853849
TimeTypeinteger

实例调度时间类型,包含以下几种时间类型:

  • cron:1
  • fix_rate:3
  • second_delay:4
  • api:100

对应枚举类:com.alibaba.schedulerx.common.domain.TimeType

1
TriggerTypeinteger

触发类型,包含以下几种触发类型:

  • 1:定时调度正常触发
  • 2:数据重刷
  • 3:API触发
  • 4:用户手动点击重跑
  • 5:系统重试(系统异常,如DB异常)

对应枚举类:com.alibaba.schedulerx.common.domain.TriggerType

1
EndTimestring

任务执行结束时间

2020-07-27 11:52:10
StartTimestring

任务执行开始时间

2020-07-27 11:52:10
Executorstring

执行人

张三
JobIdlong

任务id

92583
ScheduleTimestring

计划调度时间

2020-07-27 11:52:10
DataTimestring

任务数据时间

2020-07-27 11:52:10
WorkAddrstring

被触发客户端ip:port

192.168.0.0:16
Parametersstring

任务运行实例参数信息。

{\"alertId\":11111}
JobNamestring

任务名称

ManualJob
TraceIdstring

调用链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": "张三\n",
      "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"
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-17OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-30API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)