1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
更新工作流(包括工作流基本信息与工作流参数)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateTriggerWorkflow。 |
| Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值:1470547050521227264 |
| WorkflowId | 是 | String | 工作流ID 示例值:3dfadfde-af87-11ee-8ec8-b8599f277de5 |
| WorkflowName | 否 | String | 工作流名称 示例值:workflow2 |
| OwnerUin | 否 | String | 责任人ID 示例值:100028579801 |
| WorkflowDesc | 否 | String | 备注 示例值:更新工作流 |
| WorkflowParams.N | 否 | Array of ParamInfo | 工作流参数列表 |
| TriggerWorkflowSchedulerConfigurations.N | 否 | Array of WorkflowTriggerConfig | 统一调度参数 |
| BundleId | 否 | String | BundleId项 示例值:132 |
| BundleInfo | 否 | String | Bundle信息 示例值:bundleInfo |
| GeneralTaskParams.N | 否 | Array of WorkflowGeneralTaskParam | 通用参数配置 |
| TriggerWorkflowRunConfiguration | 否 | WorkflowRunConfig | 调度运行配置 |
| SchedulerStatus | 否 | String | Trigger 状态 启动ACTIVE,暂停PAUSED。配置完之后,内部的SchedulerStatus可不配置,如果配置,内容会被改值覆盖。 枚举值:
示例值:ACTIVE |
| TriggerMode | 否 | String | 触发方式:定时触发:TIME_TRIGGER 。配置完之后,内部的TriggerMode状态可不配置,如果配置,内容会被该值覆盖。 枚举值:
示例值:TIME_TRIGGER |
| ExecuteUserUin | 否 | String | 运行账号ID 示例值:700001893691 |
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: UpdateTriggerWorkflow
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"WorkflowId": "c6df7416-ee03-405e-adf1-094d26b8c98b",
"WorkflowName": "test_wk_2"
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "e213b6b0-385b-482d-ae96-3f1d0e81d944"
}
}
示例2 成功示例2
成功示例2
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateTriggerWorkflow
<公共请求参数>
{
"ProjectId": "31*6203***********0",
"WorkflowId": "90d110b4-79b4-4617-87f4-eee91a821fad",
"WorkflowName": "******_workflow_0729",
"OwnerUin": "*0****8936*1",
"WorkflowDesc": "1",
"WorkflowParams": [],
"TriggerWorkflowSchedulerConfigurations": [
{
"TriggerMode": "TIME_TRIGGER",
"ScheduleTimeZone": "UTC+8",
"StartTime": "2026-07-29 00:00:00",
"EndTime": "2099-12-31 23:59:59",
"ConfigMode": "COMMON",
"CycleType": "DAY_CYCLE",
"CrontabExpression": "0 0 0 * * ? *",
"TriggerId": "af1f5d11-8b49-11f1-9a90-0c42a11d9e4a",
"SchedulerStatus": "ACTIVE"
}
],
"GeneralTaskParams": [],
"TriggerWorkflowRunConfiguration": {
"MaxConcurrentNum": 1,
"QueuingMode": 1
},
"SchedulerStatus": "ACTIVE",
"TriggerMode": "TIME_TRIGGER",
"ExecuteUserUin": "****01******"
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "dd582699-b79b-4fc7-a9aa-2b47e961dda0"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |