数据开发治理平台 WeData 终止运行

1. 接口描述

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

终止运行

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：KillTriggerWorkflowRuns。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目ID 示例值：1205345798739
WorkflowId	是	String	工作流ID 示例值：dsfknknknlkas
WorkflowExecutionIdList.N	否	Array of String	指定要停止的工作流执行ID 示例值：["xsamldfmlsmflksd"]
All	否	Boolean	当指定的工作流运行为空时，是否全部终止正在运行的工作流执行示例值：true
Pending	否	Boolean	当指定的工作流运行为空时，是否仅停止等待中的工作流运行示例值：true

3. 输出参数

参数名称	类型	描述
Data	Array of ExecutionActionBrief	工作流运行操作结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 终止运行

输入示例

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

{
    "ProjectId": "1460947878944567296",
    "WorkflowId": "36f56792-1b9f-4bae-aa20-c80359f69c9c",
    "WorkflowExecutionIdList": [
        "0045ce2f-02e3-4091-8b31-3dd084ebfdb6"
    ],
    "All": false,
    "Pending": false
}

输出示例

{
    "Response": {
        "Data": [
            {
                "ErrorMessage": null,
                "ExecutionActionId": null,
                "ItemId": "0045ce2f-02e3-4091-8b31-3dd084ebfdb6",
                "ItemName": "ives_test1",
                "OpStatus": true
            }
        ],
        "RequestId": "5b0e289c-7f77-46e6-9297-7e1a3399f993"
    }
}

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	操作失败。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。