更新部分调度工作流信息

最近更新时间:2026-01-06 02:55:22

我的收藏

1. 接口描述

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

更新工作流(包括工作流基本信息与工作流参数)

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateTriggerWorkflowPartially。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目ID
示例值:1460947878944567296
WorkflowId String 工作流ID
示例值:da46d950-d5ca-4cfb-a5a9-f3c2eeea1bf0
NewSetting UpdateTriggerWorkflowPartially 责任人ID
FieldToRemoveList.N Array of String 删除字段内容,采用属性路径的形式标识,删除的值以":"分割,多个值以","分割
// 删除调度参数中 ParamKey 为 aa,bb 的属性 "WorkflowParams:aa,bb"
// 删除配置的 TriggerId 为 da46d950-d5ca-4cfb-a5a9-f3c2eeea1bf0 的调度配置"TriggerWorkflowSchedulerConfigurations :da46d950-d5ca-4cfb-a5a9-f3c2eeea1bf0"
// 删除spark sql通用参数 "GeneralTaskParams: SPARK_SQL"

示例值:["ab"]

3. 输出参数

参数名称 类型 描述
Data UpdateTriggerWorkflowResult true代表成功,false代表失败
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

成功示例

输入示例

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

{
    "ProjectId": "1460947878944567296",
    "WorkflowId": "c6df7416-ee03-405e-adf1-094d26b8c98b",
    "NewSetting": {
        "WorkflowName": "test_wk_3"
    }
}

输出示例

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "854f7e7d-9ff7-4a14-b439-54e02f281496"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。