Domain name for API request: databuddy.intl.tencentcloudapi.com.
Terminate the operation of a workflow.
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: KillWorkflowRun. |
| 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. |
| WorkflowId | Yes | String | Workflow ID. You can obtain it through ListWorkflows. Required |
| WorkflowRunIds.N | No | Array of String | List of workflow running IDs pending termination. You can obtain it through ListWorkflowRuns |
| KillAllRuns | No | Boolean | Whether to terminate all running instances in the workflow that have not entered the final state. Optional. false by default. |
| OnlyKillPendingRuns | No | Boolean | Whether to terminate only the running that is in the Waiting (Pending) state. Optional. false by default |
| Parameter Name | Type | Description |
|---|---|---|
| Data | AsyncActionRsp | Response content for terminating the workflow operation |
| 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. |
When OnlyKillPendingRuns=true, only instances waiting for resources are terminated, and running instances are not affected.
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillWorkflowRun
<Common request parameters>
{
"WorkspaceId": "17623497097012366",
"WorkflowId": "8e116990-d2b2-451a-84d3-2f890b38de4f",
"WorkflowRunIds": [
"8e116990-d2b2-451a-84d3-2f890b38de4f_1790157828891"
],
"OnlyKillPendingRuns": true
}{
"Response": {
"Data": {
"ActionResults": [
{
"ErrorMessage": "",
"OpStatus": true,
"RunActionId": "cmd_20260923180358_000001",
"WorkflowId": "8e116990-d2b2-451a-84d3-2f890b38de4f",
"WorkflowName": "",
"WorkflowRunId": "8e116990-d2b2-451a-84d3-2f890b38de4f_1790157828891"
}
]
},
"RequestId": "d8344b33-2948-4a51-949a-aa7f22039440"
}
}POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillWorkflowRun
<Common request parameters>
{
"WorkspaceId": "17697410068842890",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
"WorkflowRunIds": [
"8e0e3485-2736-4530-92ed-932e019898f1_1786115878097"
]
}{
"Response": {
"Data": {
"ActionResults": [
{
"ErrorMessage": "",
"OpStatus": true,
"RunActionId": "cmd_20260807235246_000001",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1_1786115878097",
"WorkflowName": "",
"WorkflowRunId": ""
}
]
},
"RequestId": "43957900-50db-43be-9cb2-9af3b1f278c0"
}
}Terminate all running instances of the workflow when KillAllRuns=true.
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillWorkflowRun
<Common request parameters>
{
"WorkspaceId": "17623497097012366",
"WorkflowId": "8e116990-d2b2-451a-84d3-2f890b38de4f",
"KillAllRuns": true
}{
"Response": {
"Data": {
"ActionResults": [
{
"ErrorMessage": "",
"OpStatus": true,
"RunActionId": "cmd_20260923172209_000001",
"WorkflowId": "8e116990-d2b2-451a-84d3-2f890b38de4f",
"WorkflowName": "",
"WorkflowRunId": "8e116990-d2b2-451a-84d3-2f890b38de4f_1790155291965"
}
]
},
"RequestId": "c227081f-3a22-43e7-8ca6-557cc006efbc"
}
}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.CallThirdPartApiError | Failed to call the <apiName> API of the <serviceName> service: <message>. |
| FailedOperation.NoWorkflowExecutionNeedOperate | No operation required for the workflow running |
| FailedOperation.WorkflowExecutionHasBeDelete | Workflow run deleted |
| FailedOperation.WorkflowNoPermission | No operation permissions. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.ParamBlankError | Parameter <parameter> cannot be empty. |
| InvalidParameterValue.ParamNullError | Parameter <parameter> cannot be null. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RegionError | Region error |
| ResourceNotFound | The resource does not exist. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation.WorkflowExecutionHasReachedFinalStateCannotBeStopped | Workflow run has reached the final state and cannot be terminated. |
피드백