1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
更新工作流
默认接口请求频率限制:20次/秒。
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 | 需要清空的字段名列表,用于将指定字段重置为空。每项为斜杠分隔的字段路径(如 /BaseInfo/Description、/ParamList:[参数ID]),路径段与 NewSetting 字段名一致;列表字段用 字段名:[主键值] 定位单个元素、不带 [] 表示清空整个列表;workflowId、workspaceId、baseInfo 等标识类受保护字段不可删除,路径无效或未命中将返回 InvalidParameterValue 报错。 示例值:["/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 利用FieldToRemoveList来删除工作流绑定的指定标签
通过 FieldToRemoveList 删除本工作流绑定的指定标签,标签编号为通过GetWorkflow接口返回的Data.LabelList.LabelKeyId字段,值为6263的标签
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"FieldToRemoveList": [
"/LabelList:[6263]"
]
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "ff01e545-dc82-4dc1-bedc-1244fbc8ff0d"
}
}
示例3 更新任务上游依赖(高级模式:任一条件满足)
更新任务上游依赖,运行条件为高级模式(ADVANCED):Operator=OR 表示配置的多个条件任一满足即触发;每个条件通过 UpstreamTaskId 指定上游任务、AllowedStates 指定其允许状态
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "562e7847-0499-4e61-89dd-085c9d7bfc2a",
"NewSetting": {
"TaskList": [
{
"TaskId": "b8fa8f30-eee5-4c13-8577-99cad9d8c4f7",
"DependOnList": [
{
"TaskId": "198ee412-8c01-4c4a-a65f-1348010691d0"
},
{
"TaskId": "3a6ff797-3d9c-4fa8-8fbd-2b5718e5fb94"
},
{
"TaskId": "b4d825c4-15a7-484f-a783-a8f56697790f"
}
],
"DependOnRunCondition": "ADVANCED",
"AdvancedDependencyConfig": {
"Operator": "OR",
"Conditions": [
{
"AllowedStates": [
"SUCCESS"
],
"UpstreamTaskId": "198ee412-8c01-4c4a-a65f-1348010691d0"
},
{
"AllowedStates": [
"SUCCESS"
],
"UpstreamTaskId": "3a6ff797-3d9c-4fa8-8fbd-2b5718e5fb94"
},
{
"AllowedStates": [
"FAILED"
],
"UpstreamTaskId": "b4d825c4-15a7-484f-a783-a8f56697790f"
}
]
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "ffed021a-dbaf-4467-ac91-61d9bf16d3a0"
}
}
示例4 更新任务上游依赖,运行条件为简单模式:多个上游必须全部成功
更新任务列表:通过 DependOnList 为指定任务设置多个上游依赖,并以 DependOnRunCondition 指定依赖运行条件为全部成功
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "562e7847-0499-4e61-89dd-085c9d7bfc2a",
"NewSetting": {
"TaskList": [
{
"TaskId": "b8fa8f30-eee5-4c13-8577-99cad9d8c4f7",
"DependOnList": [
{
"TaskId": "198ee412-8c01-4c4a-a65f-1348010691d0"
},
{
"TaskId": "3a6ff797-3d9c-4fa8-8fbd-2b5718e5fb94"
}
],
"DependOnRunCondition": "ALL_SUCCESS"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "8d925c00-9612-4893-93ac-7603129c49db"
}
}
示例5 更新任务重试配置
更新任务重试配置,开启任务失败重试、任务超时重试,最大重试2次,重试间隔5分钟
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "562e7847-0499-4e61-89dd-085c9d7bfc2a",
"NewSetting": {
"TaskList": [
{
"TaskId": "3a6ff797-3d9c-4fa8-8fbd-2b5718e5fb94",
"TaskRetryStrategy": {
"MaxRetryTimes": 2,
"RetryBetweenWaitTime": 5,
"RetryBetweenWaitTimeUnit": "MINUTE",
"TaskRunFailureRetrySwitch": true,
"TaskRunTimeoutRetrySwitch": true
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "aa247320-7975-4bc2-bc38-19f7f61269ac"
}
}
示例6 更新工作流和任务告警与监控指标
更新工作流和任务告警与监控指标,工作流设为监控指标告警,任务设为监控指标告警和失败告警
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"MonitorMetric": {
"Metrics": [
{
"MetricType": "RUN_DURATION",
"WarningThreshold": "3600000",
"TimeoutThreshold": "7200000"
}
],
"AlarmMonitorType": "WORKFLOW"
},
"Alarm": {
"DoNotDisturbWhenSkipped": false,
"AlarmMonitorType": "WORKFLOW",
"DoNotDisturbWhenManuallyTerminated": false,
"DoNotDisturbUntilTheLastRetry": false,
"AlarmGroups": [
{
"ChannelId": "",
"IsEmailChannel": true,
"AlarmConditions": [
"MONITOR_INDICATOR_ALARM"
],
"ChannelName": "test_user@tencent.com",
"ChannelType": 1
}
]
},
"TaskList": [
{
"Alarm": {
"AlarmId": "5e609d06-0dae-4358-9323-c8df6e0d51c2",
"DoNotDisturbWhenSkipped": false,
"AlarmMonitorType": "TASK",
"DoNotDisturbWhenManuallyTerminated": false,
"DoNotDisturbUntilTheLastRetry": false,
"AlarmGroups": [
{
"ChannelId": "",
"IsEmailChannel": true,
"AlarmConditions": [
"FAILURE",
"MONITOR_INDICATOR_ALARM"
],
"ChannelName": "test_user@tencent.com",
"ChannelType": 1
}
]
},
"TaskId": "27c91337-cc90-468c-b014-5bfb694c21f8",
"MonitorMetric": {
"MonitorMetricId": "1fab2ae1-d989-4202-9d3e-82a5387f83a4",
"Metrics": [
{
"MetricType": "RUN_DURATION",
"WarningThreshold": "600000",
"TimeoutThreshold": "900000"
}
],
"AlarmMonitorType": "TASK"
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "7ee75c0d-8d2f-4d1a-a645-fd56a3b3d305"
}
}
示例7 更新工作流的调度配置:根据Cron表达式定时触发,并设定了有效期限
更新工作流的调度配置:根据Cron表达式定时触发,并设定了有效期限。如果已经配置过调度,就需要从GetWorkflow接口返回的Data.Trigger.TriggerId进更新;否则无需传TriggerId
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"Trigger": [
{
"TriggerId": "410bc8b5-e3b6-4632-a0ba-5dae970c198a",
"SchedulerStatus": "ACTIVE",
"TriggerMode": "TIME_TRIGGER",
"SchedulerTimeZone": "Asia/Shanghai",
"StartTime": "1793030400000",
"EndTime": "1824652799000",
"ConfigMode": "CRON_EXPRESSION",
"CycleType": "CRONTAB_CYCLE",
"CrontabExpression": "0 22 1,5 * * ?"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "46908688-b5bb-4950-91ae-fda715f886e0"
}
}
示例8 更新工作流的调度配置:根据日期时间定时触发,并设定了有效期限
更新工作流的调度配置:每天 1 点执行定时触发,并设定了有效期限。如果已经配置过调度,就需要从GetWorkflow接口返回的Data.Trigger.TriggerId进更新;否则无需传TriggerId
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"Trigger": [
{
"TriggerId": "9acef20c-60dc-400b-a1bc-655a4a6afb45",
"SchedulerStatus": "ACTIVE",
"TriggerMode": "TIME_TRIGGER",
"SchedulerTimeZone": "Asia/Shanghai",
"StartTime": "1793030400000",
"EndTime": "1824652799000",
"ConfigMode": "COMMON",
"CycleType": "DAY_CYCLE",
"CrontabExpression": "0 0 1 * * ? *"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "14333b14-abfe-4914-b763-bff9fdcd35ca"
}
}
示例9 更新工作流,增加或修改一个标签
更新工作流,增加或修改一个标签
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"LabelList": [
{
"LabelKey": "label_test",
"LabelValue": "lv"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "dab4f7cc-9f26-4be4-b512-7ea2c57dfa5f"
}
}
示例10 更新工作流,增加或修改工作流参数
更新工作流,增加或修改工作流参数
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"ParamList": [
{
"ParamKey": "wp_1",
"ParamValue": "wpv_1"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "3f767675-ba88-4338-9a9d-7d1470a5c351"
}
}
示例11 更新已存在JAR任务
更新已存在JAR任务
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "37a8f5e9-abc9-4fdd-9ee7-26583df366a1",
"NewSetting": {
"TaskList": [
{
"ParamList": [],
"DependOnList": [
{
"TaskId": "60e85209-3364-49ca-b46a-8d36b4a630ed"
}
],
"TaskId": "5a60f483-fde8-4df3-8750-30ac09787a0d",
"TaskName": "test-11",
"TaskType": {
"TaskTypeName": "JAR",
"TaskTypePropertyList": [
{
"PropertyKey": "Source",
"PropertyValue": "5"
}
],
"RuntimePropertyList": [
{
"PropertyKey": "ResourceMode",
"PropertyValue": "1"
}
]
},
"ResourceGroupId": "res-c07a503e",
"Description": "",
"TaskRetryStrategy": {
"MaxRetryTimes": 3,
"RetryBetweenWaitTime": 5,
"RetryBetweenWaitTimeUnit": "MINUTE",
"TaskRunFailureRetrySwitch": true,
"TaskRunTimeoutRetrySwitch": false
},
"DependOnRunCondition": "ALL_SUCCESS",
"LeftCoordinate": 70,
"TopCoordinate": 182
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "ca485d4a-bfcb-45d2-8525-0f445c48311a"
}
}
示例12 更新已存在的Notebook任务
更新已存在的Notebook任务(来源文件在工作空间),资源模式为单节点,Driver资源规格配置为small(1CU)
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "27a49f96-004c-4438-bded-d21cb6892c8c",
"NewSetting": {
"TaskList": [
{
"TaskId": "27c91337-cc90-468c-b014-5bfb694c21f8",
"TaskType": {
"TaskTypeName": "NOTEBOOK",
"RuntimePropertyList": [
{
"PropertyKey": "ResourceMode",
"PropertyValue": "2"
},
{
"PropertyKey": "DriverCU",
"PropertyValue": "small"
}
]
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "9a4d0cff-35d8-491d-9104-ee3bf0441db1"
}
}
示例13 更新已存在的Python任务的资源配置(来源文件在GIT)
更新已存在的Python任务的资源配置(来源文件在GIT),资源模式单节点,资源配置改为medium(2CU)。
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "d940c85b-d5d0-4c26-96b2-eefe43e614cd",
"NewSetting": {
"TaskList": [
{
"TaskId": "f3e88300-5cf5-4ec7-b3ef-4805b2650d94",
"TaskType": {
"TaskTypeName": "PYTHON",
"RuntimePropertyList": [
{
"PropertyKey": "ResourceMode",
"PropertyValue": "2"
},
{
"PropertyKey": "DriverCU",
"PropertyValue": "medium"
}
]
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "13b44681-ecb0-48fb-b95e-e4b53aab9193"
}
}
示例14 更新已存在的Ray作业任务的来源文件(来源文件在工作空间)
更新已存在的Ray作业任务的来源文件(来源文件在工作空间)
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "14ed60bb-0f1c-46ab-9d51-8cf6b17cfc73",
"NewSetting": {
"TaskList": [
{
"TaskId": "cab6b8e5-6e05-4304-b2b0-a5246ef38176",
"TaskType": {
"TaskTypeName": "RAY_JOB",
"TaskTypePropertyList": [
{
"PropertyKey": "Entrypoint",
"PropertyValue": "cHl0aG9uIHNpbXBsZV90ZXN0LnB5"
},
{
"PropertyKey": "JobConfig",
"PropertyValue": "eyJSZXNvdXJjZUNvbmZpZyI6IntcIkhlYWRcIjp7XCJOYW1lXCI6XCJIZWFkXCIsXCJSZXNvdXJjZVR5cGVcIjpcIkNQVVwiLFwiQmlsbGluZ0l0ZW1cIjpcInN2X2RsY19zdGFuZGFyZF9jdV9zdGFuZGFyZF9jdVwiLFwiU3BlY1wiOjEsXCJFbnZzXCI6W10sXCJMYWJlbHNcIjpbXSxcIkhpZ2hBdmFpbGFiaWxpdHlcIjpmYWxzZSxcIlBvZE51bVwiOjF9LFwiV29ya2VyXCI6W3tcIk5hbWVcIjpcIldvcmtlckdyb3VwMDFcIixcIlJlc291cmNlVHlwZVwiOlwiQ1BVXCIsXCJCaWxsaW5nSXRlbVwiOlwic3ZfZGxjX3N0YW5kYXJkX2N1X3N0YW5kYXJkX2N1XCIsXCJTcGVjXCI6MSxcIkVudnNcIjpbXSxcIkxhYmVsc1wiOltdLFwiTWluUG9kTnVtXCI6MSxcIk1heFBvZE51bVwiOjF9XX0iLCJJbWFnZSI6ImNjci5jY3MudGVuY2VudHl1bi5jb20vZW1yLWltYWdlL3RjcmF5OnRjcmF5Mi41Ny4wLXB5MzExLWNwdSIsIkltYWdlUHVsbFR5cGUiOiJCdWlsdGluIn0="
},
{
"PropertyKey": "Source",
"PropertyValue": "5"
},
{
"PropertyKey": "JobPackage",
"PropertyValue": "/Workspace/jonsljiang/simple_test 2.py"
},
{
"PropertyKey": "WorkspaceEntryType",
"PropertyValue": "FILE"
},
{
"PropertyKey": "RunMode",
"PropertyValue": "SERVERLESS"
}
]
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "3729bcd8-6e3b-4b41-a49e-cdba3180a153"
}
}
示例15 更新已存在的SQL任务的来源文件(来源文件在工作空间)
更新已存在的SQL任务的来源文件(来源文件在工作空间)
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "0612a7de-b5f1-4348-8f44-d090ae69df35",
"NewSetting": {
"TaskList": [
{
"TaskId": "f3be8a4a-ab45-4ee3-b981-a3eb399af042",
"TaskType": {
"TaskTypeName": "SQL",
"TaskTypePropertyList": [
{
"PropertyKey": "Source",
"PropertyValue": "5"
},
{
"PropertyKey": "CodeFileId",
"PropertyValue": "798545986376953856"
}
]
}
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "35fb1b9c-4c2d-42c2-ab21-cb996c589b31"
}
}
示例16 更新排队模式+设置工作流运行最大并发数
更新工作流排队模式:开启工作流排队且工作流最大并发设置为 5
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17697410068842890",
"WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9",
"NewSetting": {
"AdvanceConfig": {
"QueuingMode": "ON",
"MaxConcurrentNum": 5
}
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
}
}
示例17 更新已存在的依赖检查节点任务
更新已存在的依赖检查节点任务
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateWorkflow
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"WorkflowId": "37a8f5e9-abc9-4fdd-9ee7-26583df366a1",
"FieldToRemoveList": [
"/TaskList:[d8bc6f84-bbd5-4e87-b80a-e9ab58975841]/MonitorMetric:[0f8c423b-0bb6-48d1-a95f-97c9147abea8]/Metrics"
],
"NewSetting": {
"TaskList": [
{
"ParamList": [],
"DependOnList": [],
"TaskId": "d8bc6f84-bbd5-4e87-b80a-e9ab58975841",
"TaskName": "test-12",
"TaskType": {
"TaskTypeName": "DEPENDENCY_SENSOR",
"TaskTypePropertyList": [
{
"PropertyKey": "checkIntervalSeconds",
"PropertyValue": "10"
}
]
},
"Description": "",
"MonitorMetric": {
"MonitorMetricId": "0f8c423b-0bb6-48d1-a95f-97c9147abea8",
"AlarmMonitorType": "TASK",
"Metrics": [
{
"MetricType": "RUN_DURATION",
"WarningThreshold": "21600000",
"TimeoutThreshold": "21600000"
}
]
},
"TaskRetryStrategy": {
"MaxRetryTimes": 3,
"RetryBetweenWaitTime": 5,
"RetryBetweenWaitTimeUnit": "MINUTE",
"TaskRunFailureRetrySwitch": true,
"TaskRunTimeoutRetrySwitch": false
},
"DependOnRunCondition": "ALL_SUCCESS",
"LeftCoordinate": 410,
"TopCoordinate": 32
}
]
}
}
输出示例
{
"Response": {
"Data": {
"Status": true
},
"RequestId": "fdc3beb7-ee94-47b8-a162-129d2388a0fc"
}
}
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.TaskGpuComputeTypeRequiredError | 任务配置了 GPU 资源扩展属性,但当前资源组不是 GPU 计算类型 |
| InvalidParameterValue.TaskHookSourceInvalid | 任务来源(Source)必须为 2(Git)或 5(工作空间) |
| InvalidParameterValue.TaskHookValidationFailed | 引用对象不存在或已被删除 |
| InvalidParameterValue.TaskNameContainsIllegalCharactersError | 任务名包含非法字符 |
| InvalidParameterValue.TaskNameExceedsLimitError | 任务名超过128字符限制 |
| InvalidParameterValue.TaskTypeNotSupportResourceGroup | 请移除该任务类型的资源组配置 |
| InvalidParameterValue.TaskTypePropertyKeyError | 任务类型属性名未在系统中注册 |
| InvalidParameterValue.TaskTypePropertyKeyValueRequestRequiredError | 任务类型属性值在入参时为必填,但是并没有传递 |
| InvalidParameterValue.TaskTypePropertyMutuallyExclusiveError | 任务类型扩展属性存在互斥属性传递的冲突,不用同时传递互斥的属性 |
| InvalidParameterValue.WorkflowNameExists | 工作流名称重复 |
| InvalidParameterValue.WorkflowNameInvalid | 工作流名称不合法 |
| InvalidParameterValue.WorkflowStartTimeAfterEndTimeError | 工作流调度开始时间不能晚于结束时间 |
| InvalidParameterValue.WorkflowTriggerAdvancedConfigError | 请检查工作流触发器高级配置,修正非法的 JSON 内容 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.WorkflowNotFound | 根据传入的工作流ID未找到工作流 |
| ResourceNotFound.WorkflowTriggerNotFound | 工作流的调度配置未找到 |