Domain name for API request: databuddy.intl.tencentcloudapi.com.
This API is used to query the list of workflows.
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: ListWorkflows. |
| 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] |
| WorkflowNameKeyword | No | String | Workflow name keyword for fuzzy matching of WorkflowName. Optional, single value |
| WorkflowNames.N | No | Array of String | Workflow name, exact match. Optional, multiple selection (OR relationship between multiple values) |
| WorkflowIds.N | No | Array of String | Workflow ID. Exact match. Optional. Multiple selection (OR relationship between multiple values) |
| RunUserUins.N | No | Array of String | Workflow runner UIN, exact match. Optional, multiple selection (OR relationship between multiple values) |
| LabelKeyIds.N | No | Array of String | Tag name ID. Exact match. You can obtain it via 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, obtainable through the tag-related API. Optional, multiple selection (multiple values are in an OR relationship with each other) |
| QuickSelectionType | No | String | Quick filter type. Optional, single value Align with the legacy Cloud API (wedata/2025-10-10) document example values:
Backend implementation status quo: currently only MY_FAVORITE takes effect (set favoriteUserUin to filter the current user's favorites). MY_OWNER / MY_AUTHORITY are not yet implemented at the Service layer, and the input will be ignored (returned as full results). |
| OrderBys.N | No | Array of OrderBy | Sorting criteria. The priority of multiple criteria is indicated by their sequence in the array. Optional. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListWorkflowsRsp | Response content of querying the workflow list |
| 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. |
This API is used to query the list of workflows.
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkflows
<Common request parameters>
{
"WorkspaceId": "17697410068842890"
}{
"Response": {
"Data": {
"Items": [
{
"BundleId": "",
"BundleInfo": "",
"CreateTime": "1785835396477",
"CreateUserUin": "*******64618",
"Description": "",
"GitConfigId": "",
"LabelList": [],
"OwnerDisplayName": "we*a***************t****",
"OwnerUserName": "w***t*****e***encent.com",
"OwnerUserUin": "700002164618",
"Permission": "MANAGE",
"ResourceGroupInfoList": [],
"RunUserName": "w***ta30-dev***********m",
"RunUserUin": "700002164618",
"TaskList": [],
"Trigger": [],
"UpdateTime": "1785835396477",
"WorkflowId": "221dc674-b463-4ea7-a1ed-d76bccf4b5e6",
"WorkflowName": "new_workflow_20260804_172315",
"WorkflowRunList": []
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1176,
"TotalPageNumber": 118
},
"RequestId": "b0ba39a2-8f9d-439e-8fa7-29a40192d50d"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.WorkflowNoPermission | No operation permissions. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.ListWorkflowFilterParamError | Invalid filter field Key value in the workflow list. |
| InvalidParameterValue.ParamBlankError | Parameter <parameter> cannot be empty. |
| InvalidParameterValue.ParamIllegalError | Parameter <parameter> does not meet requirements: <message> |
| InvalidParameterValue.WorkflowTriggerAdvancedConfigError | Please check the advanced configuration of the workflow trigger and fix the illegal JSON content. |
| MissingParameter | Parameters are missing. |
フィードバック