分页获取工作流实例列表，也可以通过条件进行筛选查询。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
是 |
项目 ID。 |
100 |
| BizDate |
integer |
是 |
业务日期。一般是周期实例定时时间的前一天的 0 点 0 分 0 秒，格式为毫秒级时间戳，如 1743350400000。 |
1710239005403 |
| Type |
string |
否 |
工作流实例的类型。
|
Normal |
| WorkflowId |
integer |
否 |
所属工作流的 ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
否 |
统一工作流实例 Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。 |
1234 |
| Name |
string |
否 |
名称。支持模糊查询。 |
WorkflowInstance1 |
| Ids |
array |
否 |
工作流实例 ID 列表，可根据工作流实例 Id 批量查询多个工作流实例信息。 |
|
|
integer |
否 |
工作流实例 ID。 |
1234 |
|
| Owner |
string |
否 |
责任人的账号 ID。 |
1000 |
| SortBy |
string |
否 |
排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下：
默认值：Id Desc |
Id Desc |
| PageSize |
integer |
否 |
每页的条目数，默认为 10。 |
10 |
| PageNumber |
integer |
否 |
页码，从 1 开始，默认为 1。 |
1 |
| Tags |
array |
否 |
标签列表，多个标签中满足一个即会返回结果。 |
|
|
string |
否 |
标签。格式为： |
key:value |
|
| Filter |
string |
否 |
过滤器。JSON 格式，多个过滤条件之间是"且"的关系。目前支持的字段有： |
{ "status": "Success", "executionDate": "1763481600000" } |
| EnvType |
string |
否 |
Prod |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求的 ID。用于定位日志，排查问题。 |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
分页信息。 |
|
| WorkflowInstances |
array<object> |
工作流实例列表。 |
|
|
array<object> |
|||
| Id |
integer |
工作流实例的唯一标识符。 |
1234 |
| WorkflowTaskInstanceId |
integer |
工作流实例对应的任务实例 ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
统一工作流实例 Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。 |
1234 |
| Name |
string |
名称。 |
WorkflowInstance1 |
| Type |
string |
工作流实例的类型。
|
Normal |
| Status |
string |
工作流实例运行状态。
|
Success |
| BizDate |
integer |
业务日期。 |
1710239005403 |
| StartedTime |
integer |
开始运行时间。 |
1710239005403 |
| FinishedTime |
integer |
完成时间。 |
1710239005403 |
| ProjectId |
integer |
项目 ID。 |
100 |
| EnvType |
string |
项目环境。
|
Prod |
| Owner |
string |
工作流的责任人的账号 ID。 |
1000 |
| CreateTime |
integer |
创建时间。 |
1710239005403 |
| ModifyTime |
integer |
修改时间。 |
1710239005403 |
| CreateUser |
string |
创建用户的账号 ID。 |
100 |
| ModifyUser |
string |
修改用户的账号 ID。 |
100 |
| WorkflowParameters |
string |
工作流参数。 |
周期工作流： key1=value1 key2=value2 手动业务流程： {"key1":"value1", "key2": "value2"} |
| WorkflowId |
integer |
所属工作流的 ID。 |
1234 |
| 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": {
"WorkflowInstances": [
{
"Id": 1234,
"WorkflowTaskInstanceId": 1234,
"UnifiedWorkflowInstanceId": 1234,
"Name": "WorkflowInstance1",
"Type": "Normal",
"Status": "Success",
"BizDate": 1710239005403,
"StartedTime": 1710239005403,
"FinishedTime": 1710239005403,
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "100",
"ModifyUser": "100",
"WorkflowParameters": "周期工作流：\nkey1=value1 key2=value2\n手动业务流程：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
"WorkflowId": 1234,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。