分页获取工作流列表，也可以通过条件进行筛选查询。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
是 |
项目 ID。 |
100 |
| EnvType |
string |
否 |
项目环境。
|
Prod |
| Ids |
array |
否 |
工作流 ID 列表，可根据工作流 Id 批量查询多个工作流信息。 |
|
|
integer |
否 |
工作流 ID。 |
1234 |
|
| Name |
string |
否 |
名称。支持模糊查询。 |
Workflow1 |
| Owner |
string |
否 |
责任人的账号 ID。 |
1000 |
| TriggerType |
string |
否 |
触发方式类型。
|
Scheduler |
| SortBy |
string |
否 |
排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下：
默认值：Id Desc |
Id Desc |
| PageSize |
integer |
否 |
每页的条目数，默认为 10。 |
10 |
| PageNumber |
integer |
否 |
页码，从 1 开始，默认为 1。 |
1 |
| Tags |
array |
否 |
标签列表，多个标签中满足一个即会返回结果。 |
|
|
string |
否 |
标签。格式为： |
key:value |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求的 ID，用于定位日志，排查问题。 |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
分页信息。 |
|
| Workflows |
array<object> |
工作流列表。 |
|
|
array<object> |
|||
| Id |
integer |
工作流的唯一标识符。 |
1234 |
| Name |
string |
名称。 |
Workflow1 |
| Description |
string |
描述信息。 |
test |
| Trigger |
object |
触发方式。 |
|
| Type |
string |
触发方式类型。
|
Scheduler |
| Recurrence |
string |
触发时的运行模式，type=Scheduler 时生效。
|
Normal |
| Cron |
string |
Cron 表达式，type=Scheduler 时生效。 |
00 00 00 * * ? |
| StartTime |
string |
周期触发生效时间，type=Scheduler 时生效。 |
1970-01-01 00:00:00 |
| EndTime |
string |
周期触发失效时间，type=Scheduler 时生效。 |
9999-01-01 00:00:00 |
| Parameters |
string |
参数列表。 |
para1=$bizdate para2=$[yyyymmdd] |
| ClientUniqueCode |
string |
工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。 |
Workflow_0bc5213917368545132902xxxxxxxx |
| ProjectId |
integer |
项目 ID。 |
100 |
| EnvType |
string |
项目环境。
|
Prod |
| Owner |
string |
责任人的账号 ID。 |
1000 |
| CreateTime |
integer |
创建时间。 |
1710239005403 |
| ModifyTime |
integer |
修改时间。 |
1710239005403 |
| CreateUser |
string |
创建用户的账号 ID。 |
1000 |
| ModifyUser |
string |
修改用户的账号 ID。 |
1000 |
| Tags |
array<object> |
任务标签 |
|
|
object |
|||
| Key |
string |
标签键。 |
key1 |
| Value |
string |
标签值。 |
value1 |
| TotalCount |
integer |
数据总条数。 |
100 |
| PageSize |
integer |
每页的条目数。 |
10 |
| PageNumber |
integer |
页码。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"PagingInfo": {
"Workflows": [
{
"Id": 1234,
"Name": "Workflow1",
"Description": "test",
"Trigger": {
"Type": "Scheduler",
"Recurrence": "Normal",
"Cron": "00 00 00 * * ?",
"StartTime": "1970-01-01 00:00:00",
"EndTime": "9999-01-01 00:00:00"
},
"Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
"ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "1000",
"ModifyUser": "1000",
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。