Domain name for API request: adp.intl.tencentcloudapi.com.
Query the list of workflow running instances
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: DescribeWorkflowRunSummaryList. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AppId | Yes | String | Application ID. For how to obtain it, see AppId |
| PageSize | Yes | Integer | Number of items per page (value ranges from 1 to 200) |
| PageNumber | Yes | Integer | Page number (must be greater than 0) |
| Domain | Yes | Integer | Execution environment. 1: Development domain, 2: Production domain - |
| FilterList.N | No | Array of Filter | Parameter filtering |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total. |
| WorkflowRunSummaryList | Array of WorkflowRunSummary | Workflow operation instance 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. |
Query the list of workflow running instances
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkflowRunSummaryList
<Common request parameters>
{
"AppId": "2075134221221714816",
"PageSize": 15,
"PageNumber": 1,
"Domain": 1,
"FilterList": [
{
"Name": "WorkflowRunId",
"ValueList": [
"wfr-cd6a2j03k5j4"
]
}
]
}
{
"Response": {
"TotalCount": 1,
"WorkflowRunSummaryList": [
{
"Domain": 1,
"WorkflowRunProfile": {
"AppId": "2075134221221714816",
"Name": "Buy a vehicle"
"WorkflowId": "f5d9e1eb-d6c3-4529-93b1-f041ea3347cc",
"WorkflowRunId": "wfr-cd6a2j03k5j4"
},
"WorkflowRunResult": {
"FailMessage": "",
"Status": 3,
"TotalTokens": 1647
},
"WorkflowRunTime": {
"CreateTime": "1783932410370",
"EndTime": "1783932471294",
"StartTime": "1783932410478"
}
}
],
"RequestId": "30fcc9bd-5239-47ce-847a-5cdedf7b50ab"
}
}
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. |
| MissingParameter | Parameters are missing. |
文档反馈