大数据智能体工作台 DataBuddy 终止工作流的运行

1. 接口描述

接口请求域名： databuddy.tencentcloudapi.com 。

终止工作流的运行

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：KillWorkflowRun。
Version	是	String	公共参数，本接口取值：2026-07-15。
Region	是	String	公共参数，详见产品支持的地域列表。
WorkspaceId	是	String	工作空间ID，可通过 ListWorkspaces 获取。必填示例值：17697410068842890
WorkflowId	是	String	工作流ID，可通过 ListWorkflows 获取。必填示例值：8e0e3485-2736-4530-92ed-932e019898f1
WorkflowRunIds.N	否	Array of String	待终止的工作流运行ID列表，可通过 ListWorkflowRuns 获取示例值：["8e0e3485-2736-4530-92ed-932e019898f1_1786115878097"]
KillAllRuns	否	Boolean	是否终止该工作流下所有未进入终态的运行。非必填，默认 false 示例值：false
OnlyKillPendingRuns	否	Boolean	是否只终止处于等待中（Pending）状态的运行。非必填，默认 false 示例值：false

3. 输出参数

参数名称	类型	描述
Data	AsyncActionRsp	终止工作流的运行响应内容注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 终止工作流的运行

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillWorkflowRun
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.CallThirdPartApiError	调用 <serviceName> 服务的接口 <apiName> 失败：<message>。
FailedOperation.NoWorkflowExecutionNeedOperate	无需操作的工作流运行
FailedOperation.WorkflowExecutionHasBeDelete	工作流运行已被删除
FailedOperation.WorkflowNoPermission	无操作权限
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.ParamBlankError	参数 <parameter> 不能为空。
InvalidParameterValue.ParamNullError	参数 <parameter> 不能为 null。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
RegionError	地域错误
ResourceNotFound	资源不存在。
UnknownParameter	未知参数错误。
UnsupportedOperation.WorkflowExecutionHasReachedFinalStateCannotBeStopped	工作流运行已到达终态，不可终止