1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
创建工作流
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateWorkflow。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| WorkspaceId | 是 | String | 工作空间ID,可通过 ListWorkspaces 获取。必填 示例值:17697410068842890 |
| BaseInfo | 是 | WorkflowBaseInfo | 工作流基本信息。必填,其中 WorkflowName 必填且工作空间内唯一 |
| Trigger.N | 否 | Array of WorkflowTriggerConfiguration | 工作流调度配置 |
| ParamList.N | 否 | Array of ParamInfo | 工作流参数列表 |
| LabelList.N | 否 | Array of LabelBrief | 标签列表 |
| Alarm | 否 | AlarmBrief | 工作流告警配置 |
| MonitorMetric | 否 | MonitorMetricBrief | 监控指标配置。若告警条件中选择了监控告警,则本字段必填 |
| AdvanceConfig | 否 | WorkflowAdvanceConfig | 工作流高级设置 |
| TaskList.N | 否 | Array of WorkflowTask | 工作流任务列表 |
| BundleId | 否 | String | BundleId,可通过 Bundle 相关接口获取 示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76 |
| BundleInfo | 否 | String | Bundle信息 示例值:demo |
| GitConfigId | 否 | String | Git配置ID,可通过 Git 配置相关接口获取 示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76 |
| GitBranch | 否 | String | Git分支信息 示例值:main |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CreateWorkflowRsp | 创建工作流响应内容 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建携带python任务的工作流
创建携带python任务的工作流
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkflow
<公共请求参数>
{
"WorkspaceId": "17697410068842890",
"BaseInfo": {
"WorkflowName": "*n**g*****n*pr**"
},
"AdvanceConfig": {
"QueuingMode": "OFF",
"MaxConcurrentNum": 1
},
"TaskList": [
{
"ParamList": [],
"DependOnList": [],
"TaskName": "py_0807",
"TaskType": {
"TaskTypeName": "PYTHON",
"TaskTypePropertyList": [
{
"PropertyKey": "Source",
"PropertyValue": "5"
}
],
"RuntimePropertyList": [
{
"PropertyKey": "ResourceMode",
"PropertyValue": "1"
}
]
},
"ResourceGroupId": "res-ea***8f8",
"TaskRetryStrategy": {},
"DependOnRunCondition": "ALL_SUCCESS",
"LeftCoordinate": 50,
"TopCoordinate": 50
}
]
}
输出示例
{
"Response": {
"Data": {
"WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
},
"RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
}
}
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.CreateWorkflowFailed | FailedOperation.CreateWorkflowFailed |
| FailedOperation.LabelCountLimit | 标签数量已达到最大允许限制 |
| FailedOperation.WorkflowCountLimit | 工作流数量超过10000上限 |
| FailedOperation.WorkflowCreateLockAcquireFailed | 获取工作流名称分布式锁失败 |
| FailedOperation.WorkflowNoPermission | 无操作权限 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicateTaskNameError | 同一工作流内存在重名任务 |
| InvalidParameterValue.ParamIllegalError | 参数 <parameter> 不符合要求:<message> |
| InvalidParameterValue.TaskHookValidationFailed | 引用对象不存在或已被删除 |
| InvalidParameterValue.TaskNameContainsIllegalCharactersError | 任务名包含非法字符 |
| InvalidParameterValue.TaskNameExceedsLimitError | 任务名超过128字符限制 |
| InvalidParameterValue.WorkflowNameExists | InvalidParameterValue.WorkflowNameExists |
| InvalidParameterValue.WorkflowNameInvalid | InvalidParameterValue.WorkflowNameInvalid |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.WorkflowNotFound | ResourceNotFound.WorkflowNotFound |