Queries a list of workflow instances by page. You can also specify filter conditions to query workflow instances.
Operation description
This API operation is available for all DataWorks editions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | long | Yes | The workspace ID. | 100 |
| BizDate | long | Yes | The data timestamp. The value of this parameter is 00:00:00 of the day before the scheduling time of the instance. The value is a UNIX timestamp. Unit: milliseconds. Example: 1743350400000. | 1710239005403 |
| Type | string | No | The type of the workflow instance. Valid values:
| Normal |
| WorkflowId | long | No | The ID of the workflow to which the instance belongs. | 1234 |
| Name | string | No | The instance name. Fuzzy match is supported. | WorkflowInstance1 |
| Ids | array | No | The IDs of the workflow instances. You can query multiple instances at a time by instance ID. | |
| Id | long | No | The workflow instance ID. | 1234 |
| Owner | string | No | The account ID of the workflow instance owner. | 1000 |
| SortBy | string | No | The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:
Default value: Id Desc. | Id Desc |
| PageSize | integer | No | The number of entries per page. Default value: 10. | 10 |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "",
"WorkflowId": 1234,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-25 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2025-10-29 | The response structure of the API has changed | View Change Details |