Filter & Paginate Workflow Instances via ListWorkflowInstances - DataWorks - Alibaba Cloud - DataWorks

Queries a list of workflow instances by page. You can also specify filter conditions to query workflow instances.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The workspace ID.	100
BizDate	integer	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: Scheduled execution Manual: Manually triggered node SmokeTest: Smoke test SupplementData: Data backfill ManualWorkflow: Manually triggered workflow TriggerWorkflow: Triggered Workflow	Normal
WorkflowId	integer	No	The ID of the workflow to which the instance belongs.	1234
UnifiedWorkflowInstanceId	integer	No	Unified workflow instance ID. All workflow instances triggered under the same data timestamp share the same value for this field.	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.
	integer	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: TriggerTime (Desc/Asc) StartedTime (Desc/Asc) FinishedTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc) 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
Tags	array	No	List of labels. A result is returned if it matches any one of the specified labels.
	string	No	Label. Format: `key:value`. If the value is empty, the format is: `key:`	key:value
Filter	string	No	Filter. In JSON format. Multiple filter conditions are combined with a logical AND. Currently supported fields are: `status, executionDate`.	{ "status": "Success", "executionDate": "1763481600000" }

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	Pagination information.
WorkflowInstances	array<object>	The workflow instances.
	array<object>
Id	integer	The workflow instance ID.	1234
WorkflowTaskInstanceId	integer	The task instance ID corresponding to the workflow instance.	1234
UnifiedWorkflowInstanceId	integer	The unified workflow instance ID. For all workflow instances triggered under the same trigger and within the same data timestamp, the value of this field is identical.	1234
Name	string	The name of the workflow instance.	WorkflowInstance1
Type	string	The type of the workflow instance. Valid values: Normal: Scheduled execution Manual: Manually triggered node SmokeTest: Smoke test SupplementData: Data backfill ManualWorkflow: Manually triggered workflow TriggerWorkflow: Triggered Workflow	Normal
Status	string	The status of the workflow instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance.	Success
BizDate	integer	Data timestamp.	1710239005403
StartedTime	integer	The time when the instance started to run.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
ProjectId	integer	The workspace ID.	100
EnvType	string	The environment of the workspace. Valid values: Prod Dev	Prod
Owner	string	The account ID of the workflow owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	100
ModifyUser	string	The account ID of the modifier.	100
WorkflowParameters	string	The workflow parameters.	Periodic workflow: key1=value1 key2=value2 Manual workflow: {"key1":"value1", "key2": "value2"}
WorkflowId	integer	The ID of the workflow to which the instance belongs.	1234
Tags	array<object>	The task tag.
	object
Key	string	The key of a tag.	key1
Value	string	The value of a tag.	value1
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "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": "Periodic workflow:\nkey1=value1 key2=value2\nManual workflow:\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
        "WorkflowId": 1234,
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.