You need to enable JavaScript to run this app.
Lake AI Service

Lake AI Service

Copy page
Download PDF
Workflow Instance
ListWorkflowInstances - Get workflow instance list
Copy page
Download PDF
ListWorkflowInstances - Get workflow instance list
Get workflow instance list​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
The following lists only the request parameters specific to this interface and some common parameters. For more information, see Common parameters.​
Action string required Example value: ListWorkflowInstances​
The operation to be performed. Value: ListWorkflowInstances.​
​
Version string required Example value: 2025-08-15​
API version. Value: 2025-08-15.​
​
SortBy string Optional Example value: StartTime​
SortBy​
​
Statuses string[] Optional Example value: [ "Running", "Succeeded" ]​
Workflow instance status list​
​
NextToken string Optional Example value: nextToken​
Starting ID (exclusive) or page number for the next query (default is 0)​
​
SortOrder string Optional Example value: Desc​
SortOrder​
​
MaxResults integer Optional Example value: 10​
Records per page​
​
ClientToken string Optional Example value: uuid-xxxxxx​
Client token​
​
WorkflowIds string[] Optional Example value: [ "wf-tpl-xxx" ]​
Workflow template ID list​
​
TriggerTypes string[] Optional Example value: [ "Manual", "Cron" ]​
Trigger type list​
​
WorkflowInstanceIds string[] Optional Example value: [ "wf-tpl-xxx-xxx" ]​
Workflow instance ID list​
​
​
​
Response parameters​
The following lists only the response parameters specific to this interface. For more information, see Response structure.​
Items object[] Example value: []​
Summary list​
Name string Example value: workflow_instance_name​
Workflow instance name​
​
EndTime string Example value: 2025-08-15T10:00:00Z​
Task end time​
​
RunEnvs object[] Example value: [ { "Name": "n1", "Value": "v1" } ]​
Job runtime environment variables​
Name string Example value: Key​
Name​
​
Value string Example value: Value​
Value​
​
​
AccountId string Example value: 2000000001​
Primary account ID​
​
StartTime string Example value: 2025-08-15T10:00:00Z​
Task start time​
​
RunOwnerId long Example value: 123456​
Executor sub-account ID​
​
UpdateTime string Example value: 2025-08-15T10:00:00Z​
Task update time​
​
WorkflowId string Example value: wf-tpl-uuid​
Workflow ID​
​
TriggerType string​
TriggerType​
​
RunOwnerName string Example value: name​
Executor sub-account name​
​
WorkflowInstanceId string Example value: wf-tpl-ea241ccb342e79e995c6-k8cnc​
Workflow instance ID​
​
Status string Example value: Running​
Workflow instance status​
​
​
NextToken string Example value: 0​
Token for the next page in paginated queries​
​
MaxResults integer Example value: 10​
Maximum number of records returned per query​
​
TotalCount long Example value: 100​
Total record count​
​
​
​
Request example​
​
POST https://open.volcengineapi.com​
{​
"SortBy": "StartTime",​
"Statuses": [​
"Running",​
"Succeeded"​
],​
"NextToken": "nextToken",​
"SortOrder": "Desc",​
"MaxResults": 10,​
"WorkflowId": "wf-tpl-xxx",​
"TriggerTypes": [​
"Manual",​
"Cron"​
]​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"Action": "ListWorkflowInstances",​
"Region": "cn-beijing",​
"Service": "las",​
"Version": "2025-08-15",​
"RequestId": "20230604110420****100232280022D31",​
"Deprecated": true​
},​
"Result": {​
"Items": [​
{​
"WorkflowInstanceId": "wf-tpl-xxx",​
"Name": "workflow_instance_name",​
"Status": "Running",​
"StartTime": "2025-08-15T10:00:00Z",​
"UpdateTime": "2025-08-15T10:00:00Z",​
"EndTime": "2025-08-15T10:00:00Z"​
}​
],​
"TotalCount": 1,​
"NextToken": "0",​
"MaxResults": 10​
}​
}​
​
Error codes​
The table below lists the error codes related to the business logic of this interface. For common error codes, see the Common error codes documentation.​
​
Status code​
Error codes​
Error message​
Note​
400​
InvalidParameter​
The specified parameter {} is invalid.​
The specified parameter {} is invalid.​
400​
DryRunOperation​
The request is validated by a dryrun operation.​
This request is validated by a dry run operation.​
400​
InvalidRequestParam​
Invalid request param {}, cause {}​
Illegal request parameter {}, cause {}​
400​
MissingParameter​
The required parameter {} is missing.​
The required parameter {} is missing.​
500​
InternalError​
The request has failed due to an unknown error.​
The request failed due to an unknown error.​
​
Last updated: 2026.08.18 16:09:14