ListWorkflowExecutions - 获取工作流实例列表

更新时间:
复制 MD 格式

获取工作流实例列表

调试

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

调试

授权信息

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

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

是

集群 ID

xxljob-b6ec1xxxx

AppName

string

否

应用名称

test-app

WorkflowId

integer

否

工作流 ID

20

WorkflowName

string

否

工作流名称

myWorkflow

WorkflowExecutionId

integer

否

工作流实例 ID

100

Status

integer

否

工作流执行状态

  • 0: unknown

  • 1: waiting

  • 2: queued

  • 3: running

  • 4: success

  • 5: failed

  • 6: killed

  • 7: held

  • 8: mark_success

  • 9: skipped

4

StartTime

string

否

开始时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2025-10-27 02:15:00

EndTime

string

否

结束时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2025-10-13 16:00:00

PageNum

integer

否

当前页码。

1

PageSize

integer

否

分页大小。

10

MaxResults

integer

否

本次读取的最大数据量,默认值为 10。

10

NextToken

string

否

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕, 第一次查询不需要提供这个参数。

eCKqVlS5FKF5EWGGOo8EgQ==

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

integer

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回

200

RequestId

string

Id of the request

BAC1ADB5-EEB5-5834-93D8-522E067AF8D9

Message

string

表示当前调用返回读取到的位置,空代表数据已经读取完毕

Parameter error: content is null.

Success

boolean

是否调用成功。

  • true:调用成功

  • false:调用失败

true

Data

object

工作流执行记录分页结果。

Records

array<object>

当前页的工作流执行记录列表。

object

单条工作流执行记录。

WorkflowExecutionId

string

工作流实例 ID

100

WorkflowId

string

工作流 ID

10

WorkflowName

string

工作流名称。

myWorkflow

ScheduleTime

string

任务调度时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2024-11-12 14:52:42

DataTime

string

任务数据时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2024-11-12 14:52:42

StartTime

string

开始时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2025-11-04 01:09:27

EndTime

string

任务结束时间,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss,格式为 YYYY-MM-DD HH:mm:ss。

2024-11-12 14:52:42

Executor

string

执行者 ID。

1827811800526000

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

AppName

string

应用名称。

test-app

Total

integer

总数。

65

PageNumber

integer

页码。

1

PageSize

integer

每页的数量。

10

MaxResults

integer

本次读取的最大数据量,默认值为 10。

10

NextToken

string

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕, 第一次查询不需要提供这个参数。

eCKqVlS5FKF5EWGGOo8EgQ==

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "BAC1ADB5-EEB5-5834-93D8-522E067AF8D9",
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "Records": [
      {
        "WorkflowExecutionId": "100",
        "WorkflowId": "10",
        "WorkflowName": "myWorkflow",
        "ScheduleTime": "2024-11-12 14:52:42",
        "DataTime": "2024-11-12 14:52:42",
        "StartTime": "2025-11-04 01:09:27",
        "EndTime": "2024-11-12 14:52:42",
        "Executor": "1827811800526000",
        "Status": 4,
        "AppName": "test-app"
      }
    ],
    "Total": 65,
    "PageNumber": 1,
    "PageSize": 10
  },
  "MaxResults": 10,
  "NextToken": "eCKqVlS5FKF5EWGGOo8EgQ=="
}

错误码

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

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

变更历史

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