1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
更新工作流
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateWorkflow。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| WorkspaceId | 是 | String | 工作空间ID,可通过 ListWorkspaces 获取。必填 示例值:17678671667189298 |
| WorkflowId | 是 | String | 待更新的工作流ID,可通过 ListWorkflows 获取。必填 示例值:8f760036-a086-49cd-9d20-7aa25c8a76be |
| FieldToRemoveList.N | 否 | Array of String | 需要清空的字段名列表,用于将指定字段重置为空 示例值:["/TaskList:[3e9e53ef-3aec-4e14-b55e-44bd07e7ee64]"] |
| NewSetting | 否 | Workflow | 更新后的工作流配置,仅传入需要变更的部分即可 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | UpdateWorkflowRsp | 更新工作流响应内容 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改工作流Git信息
修改工作流Git信息
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "8f760036-a086-49cd-9d20-7aa25c8a76be",
"NewSetting": {
"GitConfigId": "1785920869632****",
"GitBranch": "main"
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "bddfebb1-6ad0-482f-b21c-94bd5f2e7010"
}
}
示例2 更新工作流
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17697410068842890",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
"NewSetting": {
"TaskList": [
{
"ParamList": [],
"DependOnList": [],
"TaskName": "py_0807",
"TaskType": {
"TaskTypeName": "PYTHON",
"TaskTypePropertyList": [
{
"PropertyKey": "Source",
"PropertyValue": "5"
}
],
"RuntimePropertyList": [
{
"PropertyKey": "ResourceMode",
"PropertyValue": "1"
}
]
},
"ResourceGroupId": "res******8f8",
"TaskRetryStrategy": {},
"DependOnRunCondition": "ALL_SUCCESS",
"LeftCoordinate": 50,
"TopCoordinate": 50
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "516da81c-51c7-4f90-9cad-8545fb200113"
}
}
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 | 操作失败。 |
| FailedOperation.CallThirdPartApiError | 调用 <serviceName> 服务的接口 <apiName> 失败:<message>。 |
| FailedOperation.LabelCountLimit | 标签数量已达到最大允许限制 |
| FailedOperation.UpdateWorkflowFailed | 更新工作流失败 |
| FailedOperation.WorkflowBundleNoPermission | 该工作流为通过bundle包部署的内容,请勿编辑此工作流 |
| FailedOperation.WorkflowCreateLockAcquireFailed | 获取工作流名称分布式锁失败 |
| FailedOperation.WorkflowNoPermission | 无操作权限 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicateTaskNameError | 同一工作流内存在重名任务 |
| InvalidParameterValue.LoopDataArrayElementCountLimit | LoopDataArray 数组元素数量超过了最大允许值 |
| InvalidParameterValue.LoopDataArrayJsonInvalid | LoopDataArray 值既不是 JSON 数组字面量,也不是 {{var}} 占位符表达式 |
| InvalidParameterValue.LoopDataArrayNotJsonArray | LoopDataArray 值解析成功但顶层节点不是 JSON 数组 |
| InvalidParameterValue.LoopDataArrayNotJsonArrayLiteral | LoopDataArray 值既不是 JSON 数组字面量,也不是 {{var}} 占位符表达式 |
| InvalidParameterValue.LoopDataArrayValueBlank | FOR_EACH 任务的 LoopDataArray 字段为空或仅含空白字符 |
| InvalidParameterValue.LoopDataArrayValueLengthLimit | FOR_EACH 任务的 LoopDataArray 字段字符串长度超过了最大允许值 |
| InvalidParameterValue.LoopDataArrayVariableExpressionInvalid | LoopDataArray 变量表达式不满足占位符语法(大括号需成对配对且不嵌套) |
| InvalidParameterValue.ParamIllegalError | 参数 <parameter> 不符合要求:<message> |
| InvalidParameterValue.TaskHookValidationFailed | 引用对象不存在或已被删除 |
| InvalidParameterValue.TaskNameContainsIllegalCharactersError | 任务名包含非法字符 |
| InvalidParameterValue.TaskNameExceedsLimitError | 任务名超过128字符限制 |
| InvalidParameterValue.TaskTypeNotSupportResourceGroup | 请移除该任务类型的资源组配置 |
| InvalidParameterValue.TaskTypePropertyKeyValueRequestRequiredError | 任务类型属性值在入参时为必填,但是并没有传递 |
| InvalidParameterValue.WorkflowNameExists | 工作流名称重复 |
| InvalidParameterValue.WorkflowNameInvalid | 工作流名称不合法 |
| InvalidParameterValue.WorkflowStartTimeAfterEndTimeError | 工作流调度开始时间不能晚于结束时间 |
| InvalidParameterValue.WorkflowTriggerAdvancedConfigError | 请检查工作流触发器高级配置,修正非法的 JSON 内容 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.WorkflowNotExist | 工作流不存在 |
| ResourceNotFound.WorkflowNotFound | 根据传入的工作流ID未找到工作流 |
| ResourceNotFound.WorkflowTriggerNotFound | 工作流的调度配置未找到 |