获取工作流列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClusterId |
string |
是 |
集群。 |
xxljob-b6ec1xxxx |
| AppName |
string |
否 |
应用名称。 |
test-app |
| Status |
integer |
否 |
工作流状态，默认为禁用状态。
|
1 |
| WorkflowId |
integer |
否 |
工作流 ID |
20 |
| Name |
string |
否 |
工作流名称 |
myWorkflow |
| Description |
string |
否 |
工作流描述 |
my first workflow |
| PageNum |
integer |
否 |
页数 |
1 |
| PageSize |
integer |
否 |
分页大小。 |
50 |
| MaxResults |
integer |
否 |
本次读取的最大数据量，默认值为 10。 |
10 |
| NextToken |
string |
否 |
用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。 |
eCKqVlS5FKF5EWGGOo8EgQ== |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Code |
integer |
响应码。 |
200 |
| Message |
string |
错误信息。 |
Parameter error: content is null. |
| RequestId |
string |
本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。 |
39938688-0BAB-5AD8-BF02-F4910FAC7589 |
| Success |
boolean |
是否调用成功。
|
true |
| Data |
object |
数据 |
|
| Records |
array<object> |
工作流列表 |
|
|
object |
工作流基本信息 |
||
| WorkflowId |
integer |
工作流 ID |
10 |
| Name |
string |
工作流名称 |
myWorkflow |
| Description |
string |
工作流描述 |
my first workflow |
| Status |
integer |
工作流状态：
|
1 |
| MaxConcurrency |
integer |
最大并发数。 |
100 |
| TimeType |
integer |
调度类型，目前支持以下几种类型：
|
1 |
| TimeExpression |
string |
时间表达式；Cron 调度时使用 Quartz Cron 格式（秒 分 时 日 月 周）。 |
0 0 12 * * ? |
| Timezone |
string |
时区。 |
HangKong |
| Calendar |
string |
日历。 |
work-day |
| Creator |
string |
创建人。 |
1963096506470832 |
| Updater |
string |
更新者。 |
1963096506470832 |
| Xattrs |
string |
扩展属性 说明
暂不支持 |
暂无 |
| AppName |
string |
应用名。 |
test-app |
| LastExecuteEndTime |
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-06-29 15:56:36 |
| LastExecuteStatus |
integer |
上一次的执行结果。
|
4 |
| CurrentExecuteStatus |
integer |
当前执行状态：
|
3 |
| AppType |
integer |
应用类型 |
1 |
| Total |
integer |
总数。 |
64 |
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
每页数量。 |
10 |
| MaxResults |
integer |
本次读取的最大数据量，默认值为 10。 |
10 |
| NextToken |
string |
当符合查询条件的数据未读取完时，服务端会返回 nextToken，此时可以使用 nextToken 继续读取后面的数据。第一次查询不需要提供这个参数。 |
eCKqVlS5FKF5EWGGOo8EgQ== |
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "Parameter error: content is null.",
"RequestId": "39938688-0BAB-5AD8-BF02-F4910FAC7589",
"Success": true,
"Data": {
"Records": [
{
"WorkflowId": 10,
"Name": "myWorkflow",
"Description": "my first workflow",
"Status": 1,
"MaxConcurrency": 100,
"TimeType": 1,
"TimeExpression": "0 0 12 * * ?",
"Timezone": "HangKong",
"Calendar": "work-day",
"Creator": "1963096506470832",
"Updater": "1963096506470832",
"Xattrs": "暂无",
"AppName": "test-app",
"LastExecuteEndTime": "2025-06-29 15:56:36\n",
"LastExecuteStatus": 4,
"CurrentExecuteStatus": 3,
"AppType": 1
}
],
"Total": 64,
"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 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。