ListWorkflowInstances - ListWorkflowInstances-阿里云帮助中心

Returns a paginated list of workflow instances that can be filtered by specific criteria.

Operation description

Available with DataWorks Basic Edition or higher.

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 resources

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The project ID.	100
BizDate	integer	Yes	The business date. This is generally 00:00:00 of the day before the scheduled instance trigger time, in millisecond-level timestamp format, such as 1743350400000.	1710239005403
Type	string	No	The type of the workflow instance. Normal: Periodic scheduling Manual: Manual task SmokeTest: Testing SupplementData: Backfill data ManualWorkflow: Manual workflow TriggerWorkflow: Trigger-based workflow	Normal
WorkflowId	integer	No	The ID of the workflow to which the instance belongs.	1234
UnifiedWorkflowInstanceId	integer	No	The unified workflow instance ID. All workflow instances within the same business date of a single trigger share the same value for this field.	1234
Name	string	No	The name. Fuzzy match is supported.	WorkflowInstance1
Ids	array	No	The list of workflow instance IDs. You can use this parameter to query multiple workflow instances at a time.
	integer	No	The workflow instance ID.	1234
Owner	string	No	The account ID of the owner.	1000
SortBy	string	No	The list of sort fields. Sorting by trigger time, start time, and other fields is supported. The format is "sort field + sort order (Desc/Asc)" (Asc can be omitted). Valid values of the sort field: 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, starting from 1. Default value: 1.	1
Tags	array	No	The list of tags. Results are returned if any one of the specified tags is matched.
	string	No	The tag. Format: `key:value`. If the value is empty, the format is: `key:`	key:value
Filter	string	No	The filter. In JSON format, multiple filter conditions have an AND relationship. Currently supported fields are: `status, executionDate`.	{ "status": "Success", "executionDate": "1763481600000" }
EnvType	string	No		Prod

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
WorkflowInstances	array	The list of workflow instances.
	array
Id	integer	The unique identifier of the workflow instance.	1234
WorkflowTaskInstanceId	integer	The task instance ID corresponding to the workflow instance.	1234
UnifiedWorkflowInstanceId	integer	The unified workflow instance ID. All workflow instances within the same business date of a single trigger share the same value for this field.	1234
Name	string	The name.	WorkflowInstance1
Type	string	The type of the workflow instance. Normal: Periodic scheduling Manual: Manual task SmokeTest: Testing SupplementData: Backfill data ManualWorkflow: Manual workflow TriggerWorkflow: Trigger-based workflow	Normal
Status	string	The running status of the workflow instance. NotRun: Not run Running: Running WaitTime: Waiting for TriggerTime CheckingCondition: Checking branch conditions WaitResource: Waiting for resources Failure: Failed Success: Succeeded Checking: Submitted for Data Quality check	Success
BizDate	integer	The business date.	1710239005403
StartedTime	integer	The time when the instance started running.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
ProjectId	integer	The project ID.	100
EnvType	string	The project environment. Prod (production) Dev (development)	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 user who created the instance.	100
ModifyUser	string	The account ID of the user who last modified the instance.	100
WorkflowParameters	string	The workflow parameters.	Scheduled 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	The task tags.
	object
Key	string	The tag key.	key1
Value	string	The tag value.	value1
TotalCount	integer	The total number of entries.	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": "Scheduled 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.