使用ListJobExecutions获取任务实例列表-微服务引擎-阿里云-微服务引擎(MSE)-阿里云帮助中心

获取任务实例列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
AppName	string	否	应用名称。	test-app
WorkflowExecutionId	integer	否	工作流实例 ID	100
JobId	integer	否	任务 ID。	74
JobName	string	否	任务名称。	test-job
JobExecutionId	string	否	任务执行 ID。	1310630367761285120
Status	integer	否	任务执行状态。具体说明如下： 0: UNKNOWN (未知)。 1: WAITING (等待)。 2: READY (准备就绪)。 3: RUNNING (运行中)。 4: SUCCESS (成功)。 5: FAILED (失败)。 6: PAUSED (已暂停)。 7: SUBMITTED (已提交)。 8: REJECTED (被拒绝)。 9: ACCEPTED (已接受)。 10: PARTIAL_FAILED (部分失败)。 11: SKIPPED (已跳过)。 12: REMOVED (已移除)。	4
StartTime	string	否	开始时间。	2024-11-12 20:50:55
EndTime	string	否	结束时间。	2024-11-12 20:50:56
PageNum	integer	否	当前页码。	1
PageSize	integer	否	单页数据量。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码。	200
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	6BCE89B3-E882-511D-9A75-D452A56EC4B1
Message	string	错误信息。	Parameter error: content is null.
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object	查询结果。
Records	array<object>	任务实例列表
	object	任务实例
JobExecutionId	string	任务执行 ID。	1310630367761285120
JobName	string	任务名称。	test-job
JobType	string	任务类型。	xxljob
Parameters	string	任务参数。	name=zhangsan
ScheduleTime	string	任务调度时间。	2024-11-12 14:52:42
DataTime	string	任务数据时间。	2024-11-12 14:52:42
EndTime	string	任务结束时间。	2024-11-12 14:52:42
Executor	string	执行者 ID。	1827811800526000
Result	string	返回结果。	success
Status	integer	任务执行状态。具体说明如下： 0: UNKNOWN (未知)。 1: WAITING (等待)。 2: READY (准备就绪)。 3: RUNNING (运行中)。 4: SUCCESS (成功)。 5: FAILED (失败)。 6: PAUSED (已暂停)。 7: SUBMITTED (已提交)。 8: REJECTED (被拒绝)。 9: ACCEPTED (已接受)。 10: PARTIAL_FAILED (部分失败)。 11: SKIPPED (已跳过)。 12: REMOVED (已移除)。	4
TimeType	integer	时间类型： -1: none 1：cron 3：fix_rate 5：one_time 100:：api	1
Attempt	integer	失败尝试次数。	1
WorkAddr	string	任务实例的运行机器。	http://192.168.1.9:9999/
AppName	string	应用名称。	test-app
RouteStrategy	integer	路由策略。具体取值如下： 1：轮询。 2：随机。 3：第一个。 4：最后一个。 5：最不经常使用。 6：最近最久未使用。 7：一致性哈希。 8：分片广播。	1
ServerIp	string	调度节点。	28.0.168.46
TriggerType	integer	任务触发类型。具体说明如下： 0：unknown。 1：schedule。 2：rerun。 3：api。 4：user_retry。 5：system_retry。 6：manual。	1
TotalTokens	integer	AI 任务消耗的 tokens	1000
WorkflowName	string	工作流名称	myWorkflow
WorkflowExecutionId	string	工作流实例 ID	100
JobId	integer	任务 ID。	74
Duration	integer	运行总时长。	10
WorkflowId	integer	工作流 ID	10
XAttrs	string		{"sessionId":"ac21f9f6-5a88-4f97-abd1-b51989166035"}
Total	integer	数据总条数。	20
PageNumber	integer	当前页。	1
PageSize	integer	每页的数量。	10

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "6BCE89B3-E882-511D-9A75-D452A56EC4B1",
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "Records": [
      {
        "JobExecutionId": "1310630367761285120",
        "JobName": "test-job",
        "JobType": "xxljob",
        "Parameters": "name=zhangsan",
        "ScheduleTime": "2024-11-12 14:52:42",
        "DataTime": "2024-11-12 14:52:42",
        "EndTime": "2024-11-12 14:52:42",
        "Executor": "1827811800526000",
        "Result": "success",
        "Status": 4,
        "TimeType": 1,
        "Attempt": 1,
        "WorkAddr": "http://192.168.1.9:9999/",
        "AppName": "test-app",
        "RouteStrategy": 1,
        "ServerIp": "28.0.168.46",
        "TriggerType": 1,
        "TotalTokens": 1000,
        "WorkflowName": "myWorkflow",
        "WorkflowExecutionId": "100",
        "JobId": 74,
        "Duration": 10,
        "WorkflowId": 10,
        "XAttrs": "{\"sessionId\":\"ac21f9f6-5a88-4f97-abd1-b51989166035\"}"
      }
    ],
    "Total": 20,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

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

变更历史

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