获取分片任务执行的详情。

接口说明

引入增强插件

在pom.xml文件中添加增强插件以提升 Executor 的能力。

注意：请确保该插件在 pom 中放置在xxl-job-core 依赖的上方。

详细信息请参考：插件版本说明文档

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
AppName	string	是	应用名称。	test-app
JobExecutionId	string	是	任务执行 ID。	1310630367761285120

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码。	200
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	9B57FDD7-ABBE-5030-B348-86EB9943DB59
Message	string	错误信息。	Parameter format error
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object
JobDescription	string	任务描述。	测试任务
TotalProgress	object	任务整体进度。
Total	integer	总数量。	30
Finished	integer	完成的数量。	15
RootProgress	object	根任务进度。
Total	integer	总数量。	2
Finished	integer	完成的数量。	2
TaskProgress	array<object>	子任务进度。
	object	子任务进度。
Name	string	任务名称。	calendar_test_2
Total	integer	总数。	1000
Pulled	integer	已拉取数量。	10
Queue	integer	队列中数量。	100
Running	integer	运行中数量。	1
Success	integer	成功的数量。	100
Failed	integer	已失败数量。	100
ShardingProgress	array<object>	分片任务进度。
	array<object>	分片任务进度。
Id	integer	ID。	1
WorkerAddr	string	机器地址。	http://192.168.***.9:9999/
Status	integer	任务执行状态。具体说明如下： 0：unknown。 1：init。 2：pulled。 3：running。 4：success。 5：failed。	5
StatusType	object	状态类型。
Code	string	任务状态码。	5
Name	string	状态名称	TaskStatus.FAILED
Tips	object	提示信息。
	string	提示信息。	Task execution failed
JobExecutionId	string	分片执行 ID。	1306189481388277762
Result	string	分片执行结果。	2,4,6,8,10
WorkerProgress	array<object>	机器维度执行进度。
	object	机器维度执行进度。
WorkerAddr	string	机器地址。	10.*.*.53:61941
Total	integer	总数。	100
Pulled	integer	已拉取数量。	20
Queue	integer	队列中数量。	20
Running	integer	运行中数量。	20
Success	integer	成功的数量。	20
Failed	integer	已失败数量。	20
TraceId	string	全链路 ID。	1a0e97fb17244665327205402dbd6d
StartTime	string	开始时间	1758506761000
EndTime	string	结束时间	1758594961000

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "9B57FDD7-ABBE-5030-B348-86EB9943DB59",
  "Message": "Parameter format error",
  "Success": true,
  "Data": {
    "JobDescription": "测试任务",
    "TotalProgress": {
      "Total": 30,
      "Finished": 15
    },
    "RootProgress": {
      "Total": 2,
      "Finished": 2
    },
    "TaskProgress": [
      {
        "Name": "calendar_test_2",
        "Total": 1000,
        "Pulled": 10,
        "Queue": 100,
        "Running": 1,
        "Success": 100,
        "Failed": 100
      }
    ],
    "ShardingProgress": [
      {
        "Id": 1,
        "WorkerAddr": "http://192.168.***.9:9999/",
        "Status": 5,
        "StatusType": {
          "Code": "5",
          "Name": "TaskStatus.FAILED",
          "Tips": {
            "key": "Task execution failed"
          }
        },
        "JobExecutionId": "1306189481388277762",
        "Result": "2,4,6,8,10"
      }
    ],
    "WorkerProgress": [
      {
        "WorkerAddr": "10.***.***.53:61941\n",
        "Total": 100,
        "Pulled": 20,
        "Queue": 20,
        "Running": 20,
        "Success": 20,
        "Failed": 20,
        "TraceId": "1a0e97fb17244665327205402dbd6d"
      }
    ],
    "StartTime": "1758506761000",
    "EndTime": "1758594961000"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
500	InternalError	InternalError: %s.	系统内部错误：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s

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

变更历史

更多信息，参考变更详情。