帮你快速理解、总结文档立即下载

创建工作流

最近更新时间:2026-11-06 01:41:55
我的收藏

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信息


示例值:{"bundle_name":"test_bj","bundle_path":"/Workspace/Users/gaohan@100048098877/.bundle/test_bj/dev/files/resources/workflow/sql_workflow.yml"}
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 创建Cron定时调度的工作流(含参数/标签/监控告警/Git/排队并发,不含任务)

创建不含任务的工作流,配置 Cron 表达式定时调度(每天 0 点、Asia/Shanghai、含起止有效期)、工作流参数与标签、运行时长监控指标与告警、Git 仓库关联及排队模式(最大并发 2)

输入示例

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

{
    "WorkspaceId": "17678671667189298",
    "BaseInfo": {
        "WorkflowName": "test_workflow_1030"
    },
    "Trigger": [
        {
            "StartTime": "1793203200000",
            "EndTime": "1824815014000",
            "TriggerMode": "TIME_TRIGGER",
            "ConfigMode": "CRON_EXPRESSION",
            "SchedulerStatus": "ACTIVE",
            "CrontabExpression": "0 0 0 * * ? *",
            "SchedulerTimeZone": "Asia/Shanghai",
            "CycleType": "CRONTAB_CYCLE"
        }
    ],
    "ParamList": [
        {
            "ParamKey": "wp1",
            "ParamValue": "wpv1"
        },
        {
            "ParamKey": "wp2",
            "ParamValue": "wpv2"
        }
    ],
    "LabelList": [
        {
            "LabelKey": "lb_test1",
            "LabelValue": "lbv1"
        },
        {
            "LabelKey": "lb_test2",
            "LabelValue": "lbv2"
        }
    ],
    "MonitorMetric": {
        "Metrics": [
            {
                "MetricType": "RUN_DURATION",
                "WarningThreshold": "3600000",
                "TimeoutThreshold": "5400000"
            }
        ],
        "AlarmMonitorType": "WORKFLOW"
    },
    "Alarm": {
        "AlarmGroups": [
            {
                "ChannelId": "",
                "ChannelName": "xxx@yyy.com",
                "IsEmailChannel": true,
                "ChannelType": 1,
                "AlarmConditions": [
                    "FAILURE",
                    "MONITOR_INDICATOR_ALARM"
                ]
            }
        ],
        "AlarmMonitorType": "WORKFLOW",
        "DoNotDisturbWhenSkipped": false,
        "DoNotDisturbWhenManuallyTerminated": false,
        "DoNotDisturbUntilTheLastRetry": false
    },
    "GitConfigId": "17879110044139837",
    "GitBranch": "main",
    "AdvanceConfig": {
        "QueuingMode": "ON",
        "MaxConcurrentNum": 2
    }
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "2b938d4c-2493-4676-ba1a-91d4e60a739a"
        },
        "RequestId": "185e832a-49cd-400e-8366-a9f2eb6e72b4"
    }
}

示例2 创建完整配置的工作流(参数/标签/告警/监控/排队)

创建包含工作流参数、标签、邮件告警、监控指标、排队模式等完整配置的工作流

输入示例

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

{
    "WorkspaceId": "17697410068842890",
    "BaseInfo": {
        "WorkflowName": "dwd_full_config_workflow",
        "OwnerUserName": "tom"
    },
    "ParamList": [
        {
            "ParamKey": "ds",
            "ParamValue": "${yyyy-MM-dd}"
        }
    ],
    "LabelList": [
        {
            "LabelKey": "department",
            "LabelValue": "sales"
        }
    ],
    "Alarm": {
        "AlarmMonitorType": "WORKFLOW",
        "AlarmGroups": [
            {
                "ChannelId": "f4ec3e79-7368-44c9-8b04-031fad7f1a76",
                "ChannelName": "alarm@example.com",
                "IsEmailChannel": true,
                "AlarmConditions": [
                    "START",
                    "FAILURE"
                ],
                "ChannelType": 1
            }
        ],
        "DoNotDisturbWhenSkipped": false,
        "DoNotDisturbWhenManuallyTerminated": false,
        "DoNotDisturbUntilTheLastRetry": false
    },
    "MonitorMetric": {
        "AlarmMonitorType": "WORKFLOW",
        "Metrics": [
            {
                "MetricType": "RUN_DURATION",
                "WarningThreshold": "3600",
                "TimeoutThreshold": "7200"
            }
        ]
    },
    "AdvanceConfig": {
        "QueuingMode": "OFF",
        "MaxConcurrentNum": 1
    },
    "TaskList": [
        {
            "TaskName": "sql_0807",
            "ParamList": [],
            "DependOnList": [],
            "TaskType": {
                "TaskTypeName": "SQL",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    },
                    {
                        "PropertyKey": "CodeFileId",
                        "PropertyValue": "file-9a1670f314df"
                    },
                    {
                        "PropertyKey": "SqlPath",
                        "PropertyValue": "/Workspace/sql/dwd_daily_sales.sql"
                    }
                ],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {},
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
        },
        "RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
    }
}

示例3 创建定时调度且多任务依赖的工作流

创建定时调度(每日 2 点)且三任务依赖串联(含高级依赖:上游失败也继续)的工作流

输入示例

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

{
    "WorkspaceId": "17697410068842890",
    "BaseInfo": {
        "WorkflowName": "dwd_sales_etl"
    },
    "Trigger": [
        {
            "SchedulerStatus": "START",
            "TriggerMode": "TIME_TRIGGER",
            "SchedulerTimeZone": "Asia/Shanghai",
            "StartTime": "1769740800000",
            "EndTime": "1798761600000",
            "ConfigMode": "COMMON",
            "CycleType": "DAY",
            "CrontabExpression": "0 0 2 * * *",
            "AdvancedConfig": {
                "TaskRetryMode": "onFailure"
            }
        }
    ],
    "TaskList": [
        {
            "TaskName": "sql_extract",
            "ParamList": [],
            "DependOnList": [],
            "TaskType": {
                "TaskTypeName": "SQL",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    },
                    {
                        "PropertyKey": "CodeFileId",
                        "PropertyValue": "file-9a1670f314df"
                    },
                    {
                        "PropertyKey": "SqlPath",
                        "PropertyValue": "/Workspace/sql/dwd_daily_sales.sql"
                    }
                ],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {},
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50
        },
        {
            "TaskName": "sql_transform",
            "ParamList": [],
            "DependOnList": [
                {
                    "TaskId": "000001",
                    "TaskName": "sql_extract"
                }
            ],
            "TaskType": {
                "TaskTypeName": "SQL",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    },
                    {
                        "PropertyKey": "CodeFileId",
                        "PropertyValue": "file-9a1670f314df"
                    },
                    {
                        "PropertyKey": "SqlPath",
                        "PropertyValue": "/Workspace/sql/dwd_daily_sales.sql"
                    }
                ],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {},
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50,
            "AdvancedDependencyConfig": {
                "Operator": "OR",
                "Conditions": [
                    {
                        "UpstreamTaskId": "000001",
                        "UpstreamTaskName": "sql_extract",
                        "AllowedStates": [
                            "SUCCESS",
                            "FAILED"
                        ]
                    }
                ]
            }
        },
        {
            "TaskName": "py_report",
            "ParamList": [],
            "DependOnList": [
                {
                    "TaskId": "000002",
                    "TaskName": "sql_transform"
                }
            ],
            "TaskType": {
                "TaskTypeName": "PYTHON",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    }
                ],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {
                "MaxRetryTimes": "3",
                "RetryBetweenWaitTime": "5",
                "RetryBetweenWaitTimeUnit": "MINUTE",
                "TaskRunFailureRetrySwitch": "true",
                "TaskRunTimeoutRetrySwitch": "false"
            },
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
        },
        "RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
    }
}

示例4 创建携带Notebook,SQL,离线数据同步任务,且有任务间高级依赖关系的工作流

创建携带Notebook,SQL,离线数据同步任务,且有任务间高级依赖关系(Notebook任务依赖SQL和离线数据同步任务)的工作流

输入示例

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

{
    "WorkspaceId": "17678671667189298",
    "BaseInfo": {
        "WorkflowName": "test_workflow_1028"
    },
    "TaskList": [
        {
            "TaskName": "test_notebook_1028",
            "ResourceGroupId": "res-c07a503e",
            "DependOnList": [
                {
                    "TaskName": "test_integration_1028_left"
                },
                {
                    "TaskName": "test_sql_1028_right"
                }
            ],
            "DependOnRunCondition": "ADVANCED",
            "AdvancedDependencyConfig": {
                "Operator": "OR",
                "Conditions": [
                    {
                        "AllowedStates": [
                            "SUCCESS"
                        ],
                        "UpstreamTaskName": "test_integration_1028_left"
                    },
                    {
                        "AllowedStates": [
                            "FAILED"
                        ],
                        "UpstreamTaskName": "test_sql_1028_right"
                    }
                ]
            },
            "TaskType": {
                "TaskTypeName": "NOTEBOOK",
                "RuntimePropertyList": [
                    {
                        "PropertyKey": "ResourceMode",
                        "PropertyValue": "1"
                    },
                    {
                        "PropertyKey": "ConfigType",
                        "PropertyValue": "CUSTOM"
                    },
                    {
                        "PropertyKey": "ExecutorAllocation",
                        "PropertyValue": "DYNAMIC"
                    },
                    {
                        "PropertyKey": "ExecutorCU",
                        "PropertyValue": "small"
                    },
                    {
                        "PropertyKey": "ExecutorMinNum",
                        "PropertyValue": "1"
                    },
                    {
                        "PropertyKey": "ExecutorMaxNum",
                        "PropertyValue": "15"
                    },
                    {
                        "PropertyKey": "DriverCU",
                        "PropertyValue": "small"
                    },
                    {
                        "PropertyKey": "Style",
                        "PropertyValue": "UI"
                    }
                ],
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    },
                    {
                        "PropertyKey": "NotebookPath",
                        "PropertyValue": "/Workspace/notebook_task.ipynb"
                    }
                ]
            }
        },
        {
            "TaskName": "test_integration_1028_left",
            "ResourceGroupId": "res-00b25e3a",
            "TaskType": {
                "TaskTypeName": "DATA_INTEGRATION",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "4"
                    },
                    {
                        "PropertyKey": "DataIntegrationTaskId",
                        "PropertyValue": "b4c20ebe-dd13-4875-8ab1-e645d9ca3910"
                    }
                ]
            }
        },
        {
            "TaskName": "test_sql_1028_right",
            "ResourceGroupId": "res-c07a503e",
            "TaskType": {
                "TaskTypeName": "SQL",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "5"
                    },
                    {
                        "PropertyKey": "CodeFileId",
                        "PropertyValue": "798545986376953856"
                    },
                    {
                        "PropertyKey": "CodeFileVersion",
                        "PropertyValue": "871098798448340992"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "d0fb9645-f362-43b8-85bc-07a8cbddd2b9"
        },
        "RequestId": "fbe445ce-0ba0-4cdf-b417-aeac83ec1979"
    }
}

示例5 创建携带Ray作业(配置了任务监控指标、告警和重试策略),质量监控,嵌套工作流任务,且有上游全部成功的任务间简单依赖关系的工作流

创建携带Ray作业(配置了任务监控指标、告警和重试策略),质量监控,嵌套工作流任务,且有上游全部成功的任务间简单依赖关系的工作流

输入示例

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

{
    "WorkspaceId": "17678671667189298",
    "BaseInfo": {
        "WorkflowName": "test_workflow_1029"
    },
    "TaskList": [
        {
            "TaskName": "test_ray_1028",
            "ResourceGroupId": "res-raydev01",
            "DependOnList": [
                {
                    "TaskName": "test_dq_1028_left"
                },
                {
                    "TaskName": "test_run_workflow_1028_right"
                }
            ],
            "DependOnRunCondition": "ALL_SUCCESS",
            "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"
                    }
                ]
            },
            "TaskRetryStrategy": {
                "RetryBetweenWaitTimeUnit": "MINUTE",
                "RetryBetweenWaitTime": 5,
                "MaxRetryTimes": 2,
                "TaskRunTimeoutRetrySwitch": false,
                "TaskRunFailureRetrySwitch": true
            },
            "Alarm": {
                "AlarmMonitorType": "TASK",
                "AlarmGroups": [
                    {
                        "ChannelId": "",
                        "ChannelName": "test_user@xxx.com",
                        "ChannelType": 1,
                        "IsEmailChannel": true,
                        "AlarmConditions": [
                            "FAILURE",
                            "MONITOR_INDICATOR_ALARM"
                        ]
                    }
                ],
                "DoNotDisturbWhenSkipped": false,
                "DoNotDisturbWhenManuallyTerminated": false,
                "DoNotDisturbUntilTheLastRetry": false
            },
            "MonitorMetric": {
                "AlarmMonitorType": "TASK",
                "Metrics": [
                    {
                        "MetricType": "RUN_DURATION",
                        "WarningThreshold": "60000",
                        "TimeoutThreshold": "120000"
                    }
                ]
            }
        },
        {
            "TaskName": "test_dq_1028_left",
            "ResourceGroupId": "res-c07a503e",
            "TaskType": {
                "TaskTypeName": "DATA_QUALITY",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "SourceUniqueId",
                        "PropertyValue": "dd6c42d1-d36d-4f7f-905b-4db4a83ce6c9"
                    },
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "4"
                    },
                    {
                        "PropertyKey": "TemplatePath",
                        "PropertyValue": "quality/tasks/17678671667189298/dd6c42d1-d36d-4f7f-905b-4db4a83ce6c9/published/templates.json"
                    }
                ]
            }
        },
        {
            "TaskName": "test_run_workflow_1028_right",
            "TaskType": {
                "TaskTypeName": "RUN_WORKFLOW",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "WorkflowId",
                        "PropertyValue": "27a49f96-004c-4438-bded-d21cb6892c8c"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "958dfa6f-a6e6-41fa-bdb7-97a5a923f40c"
        },
        "RequestId": "16b27bd7-9e0a-440a-bee2-82866561e5f0"
    }
}

示例6 创建携带嵌套工作流任务的工作流

创建携带嵌套工作流(RUN_WORKFLOW)任务的工作流,通过 WorkflowId 属性指定目标工作流

输入示例

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

{
    "WorkspaceId": "17697410068842890",
    "BaseInfo": {
        "WorkflowName": "sub_wf_caller_workflow"
    },
    "TaskList": [
        {
            "TaskName": "sub_wf_caller",
            "ParamList": [],
            "DependOnList": [],
            "TaskType": {
                "TaskTypeName": "RUN_WORKFLOW",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "WorkflowId",
                        "PropertyValue": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
                    }
                ],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {},
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
        },
        "RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
    }
}

示例7 创建携带数据质量任务的工作流

创建携带数据质量(DATA_QUALITY)任务的工作流,属性列表参考 ListWorkflowTaskTypeProperties 接口

输入示例

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

{
    "WorkspaceId": "17697410068842890",
    "BaseInfo": {
        "WorkflowName": "dq_check_workflow"
    },
    "TaskList": [
        {
            "TaskName": "dq_0807",
            "ParamList": [],
            "DependOnList": [],
            "TaskType": {
                "TaskTypeName": "DATA_QUALITY",
                "TaskTypePropertyList": [],
                "RuntimePropertyList": []
            },
            "ResourceGroupId": "res-ea1234568f8",
            "TaskRetryStrategy": {},
            "DependOnRunCondition": "ALL_SUCCESS",
            "LeftCoordinate": 50,
            "TopCoordinate": 50
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "9a1670f3-14df-4869-9f38-ec31a4c4aac9"
        },
        "RequestId": "81772cad-5e71-4a7c-b063-a7b5db0d929a"
    }
}

示例8 创建一个携带Python任务的工作流

创建一个携带Python任务的工作流,任务来源为git,资源模式为单节点,资源配置small(1CU)。

输入示例

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

{
    "WorkspaceId": "17678671667189298",
    "BaseInfo": {
        "WorkflowName": "test_workflow_1031"
    },
    "GitBranch": "main",
    "GitConfigId": "17879110044139837",
    "TaskList": [
        {
            "TaskName": "py_0807",
            "ResourceGroupId": "res-46e4a9a0",
            "TaskType": {
                "TaskTypeName": "PYTHON",
                "TaskTypePropertyList": [
                    {
                        "PropertyKey": "Source",
                        "PropertyValue": "2"
                    },
                    {
                        "PropertyKey": "SourcePath",
                        "PropertyValue": "1234.py"
                    }
                ],
                "RuntimePropertyList": [
                    {
                        "PropertyKey": "ResourceMode",
                        "PropertyValue": "2"
                    },
                    {
                        "PropertyKey": "DriverCU",
                        "PropertyValue": "small"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "WorkflowId": "d940c85b-d5d0-4c26-96b2-eefe43e614cd"
        },
        "RequestId": "6843c1e7-ddfd-433c-90b6-634371a40750"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallThirdPartApiError 调用 <serviceName> 服务的接口 <apiName> 失败:<message>。
FailedOperation.CreateWorkflowFailed 创建工作流失败
FailedOperation.LabelCountLimit 标签数量已达到最大允许限制
FailedOperation.WorkflowCountLimit 工作流数量超过10000上限
FailedOperation.WorkflowCreateLockAcquireFailed 获取工作流名称分布式锁失败
FailedOperation.WorkflowNoPermission 无操作权限
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicateTaskNameError 同一工作流内存在重名任务
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.WorkflowTriggerAdvancedConfigError 请检查工作流触发器高级配置,修正非法的 JSON 内容
MissingParameter 缺少参数错误。
ResourceNotFound.WorkflowNotFound 根据传入的工作流ID未找到工作流