Domain name for API request: databuddy.intl.tencentcloudapi.com.
Workflow run list
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ListWorkflowRuns. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| WorkspaceId | Yes | String | Workspace ID, which can be obtained through ListWorkspaces. Required. |
| PageNumber | No | Integer | Page number. Value range: starts from 1. Optional. Default value: 1. |
| PageSize | No | Integer | Size per page. Optional. Default: 10. Value range: [10, 200] |
| WorkflowId | No | String | Workflow ID, exact match. Optional, single value |
| WorkflowNameKeyword | No | String | Workflow name keyword for fuzzy matching of WorkflowName. Optional, single value |
| CreateStartTime | No | String | Lower bound for the running creation time, range match (CreateTime >= this value), unit: timestamp in milliseconds. |
| CreateEndTime | No | String | Upper bound for the running creation time, range match (CreateTime <= this value), unit: timestamp in milliseconds. |
| RunStates.N | No | Array of String | RUNNING state. Exact matching. Optional. Multiple selection (multiple values are in OR relationship with each other). RUNNING state. CREATE("initialization"), QUEUED("Waiting"), PENDING("preparing"), RUNNING("RUNNING"), SKIPPED("skip RUNNING"), SUCCESS("successful"), FAILED("failure"), TERMINATING("TERMINATING"), TERMINATED("termination"), CANCELLED("manual termination"), etc. |
| ErrorCodeStrings.N | No | Array of String | Error code, exact match. Optional, multiple selection (OR relationship between multiple values) |
| RunUserUins.N | No | Array of String | Operator UIN, exact match. Optional, multiple selection (OR relationship between multiple values) |
| LabelKeyIds.N | No | Array of String | Tag name ID, exact match, obtainable through tag-related APIs. Optional, multiple selection (multiple values are in an OR relationship with each other) |
| LabelValueIds.N | No | Array of String | Tag value ID. Exact match. It can be obtained through the tag-related API. Optional. Multiple selection (multiple values are in OR relationship with each other) |
| OrderBys.N | No | Array of OrderBy | Sorting conditions. The priority of multiple conditions is indicated by the array order. Optional. Default: CreateTime Desc. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListWorkflowRunsRsp | Workflow run list response content |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkflowRuns
<Common request parameters>
{
"WorkspaceId": "17678671667189298",
"PageNumber": 1,
"PageSize": 10,
"WorkflowId": "8e8a8cd9-633f-4fae-b5fa-f376a4d31da7"
}{
"Response": {
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 125,
"TotalPageNumber": 13,
"Items": [
{
"AppId": "260073493",
"WorkflowName": "www1",
"WorkflowId": "8e8a8cd9-633f-4fae-b5fa-f376a4d31da7",
"WorkflowRunId": "8e8a8cd9-633f-4fae-b5fa-f376a4d31da7_1789995691987",
"WorkspaceId": "17678671667189298",
"TriggerType": "",
"RunStartTime": "0",
"PendingStartTime": "0",
"QueueStartTime": "0",
"RunEndTime": "0",
"EndTime": "0",
"RunCostTime": "0",
"QueueCostTime": "0",
"PendingCostTime": "1",
"RunState": "QUEUED",
"ResourceGroupIds": [],
"RunUserUin": "700002164619",
"RunUserName": "",
"ErrorCodeString": "",
"WorkflowParams": "",
"WorkflowVersionId": "381cae4e-d8af-40d6-9b0d-79d0fad8b21f",
"SupportRerun": false,
"CreateTime": "1789995692013",
"RerunTimes": 0,
"SelectedTaskIds": [
"9aa66a88-9a88-4a98-9d7f-1b92e3aedbff"
],
"ResourceGroupInfoList": [],
"LabelList": [],
"ParentWorkflowRunId": "",
"ParentWorkflowTaskRunId": "",
"ParentWorkflowTaskRunName": "",
"Permission": "MANAGE",
"AdvancedParameters": [],
"ScheduledTime": "1789995691987"
}
],
"BizStateEnumInfos": [
{
"LabelKey": "SUCCESS",
"LabelValue": "Successful",
"Count": 78
}
],
"BizErrorCodeEnumInfos": [
{
"LabelKey": "ExecutionFailed",
"LabelValue": "ExecutionFailed",
"Count": 11
}
]
},
"RequestId": "d088d842-0a4f-4141-af82-50dde96919c4"
}
}Query the workflow run list under a workspace with default pagination.
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkflowRuns
<Common request parameters>
{
"WorkspaceId": "17697410068842890"
}{
"Response": {
"Data": {
"BizErrorCodeEnumInfos": [
{
"Count": 12576,
"LabelKey": "",
"LabelValue": ""
}
],
"BizStateEnumInfos": [
{
"Count": 12091,
"LabelKey": "SUCCESS",
"LabelValue": "Success"
}
],
"Items": [
{
"AdvancedParameters": [],
"AppId": "251436191",
"CreateTime": "1786115878109",
"EndTime": "0",
"ErrorCodeString": "",
"LabelList": [],
"ParentWorkflowRunId": "",
"ParentWorkflowTaskRunId": "",
"ParentWorkflowTaskRunName": "",
"PendingCostTime": "37",
"PendingStartTime": "0",
"Permission": "MANAGE",
"QueueCostTime": "0",
"QueueStartTime": "0",
"RerunTimes": 0,
"ResourceGroupIds": [],
"ResourceGroupInfoList": [],
"RunCostTime": "0",
"RunEndTime": "0",
"RunStartTime": "0",
"RunState": "QUEUED",
"RunUserName": "",
"RunUserUin": "700002164618",
"SelectedTaskIds": [
"40d34e5c-12d9-4ac3-88ed-2f879713d4e4"
],
"SupportRerun": false,
"TriggerType": "",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
"WorkflowName": "new_workflow_20260807_190451",
"WorkflowParams": "{\"pppp1\":\"vvvv1\"}",
"WorkflowRunId": "8e0e3485-2736-4530-92ed-932e019898f1_1786115878097",
"WorkflowVersionId": "bcac4a2c-a47a-453b-8e31-34282e556db2",
"WorkspaceId": "17697410068842890"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 106670,
"TotalPageNumber": 10667
},
"RequestId": "5f543f6f-7fae-47e9-8add-eb9d045d1bea"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.ExistWorkflowExecutions | Existent active workflow is running and cannot operate. |
| FailedOperation.WorkflowNoPermission | No operation permissions. |
| InternalError | Internal error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameterValue.InvalidParameter | Parameter error. |
| InvalidParameterValue.ParamBlankError | Parameter <parameter> cannot be empty. |
| InvalidParameterValue.ParamIllegalError | Parameter <parameter> does not meet requirements: <message> |
| InvalidParameterValue.ParamNullError | Parameter <parameter> cannot be null. |
| InvalidParameterValue.WorkflowEndTimeLessStartTime | End time cannot be earlier than start time. |
| InvalidParameterValue.WorkflowQueryEndTimeAndStartTimeExceed | Query time range exceeds the 60-day limit. |
| MissingParameter.MissingParameter | Missing required parameters |
| ResourceNotFound.WorkflowNotExist | Workflow does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback