创建流水线模板
功能介绍
创建流水线模板
调用方法
请参见如何调用API。
URI
POST /v5/{tenant_id}/api/pipeline-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tenant_id | 是 | String | 参数解释： 租户ID，用户的domainId。 约束限制： 不涉及。 取值范围： 32位字符，仅由数字和字母组成。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。通过调用获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释： 模板名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| description | 否 | String | 参数解释： 模板描述。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| language | 是 | String | 参数解释： 模板语言。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| variables | 否 | Array of CustomVariableVO objects | 参数解释： 自定义参数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| definition | 是 | String | 参数解释： 模板编排json，包含stages。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| is_system | 是 | Boolean | 参数解释： 是否系统模板。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
| domain_id | 是 | String | 参数解释： 租户ID，用户的domainId。 约束限制： 不涉及。 取值范围： 32位字符，由数字和字母组成。 默认取值： 不涉及。 |
| is_show_source | 是 | Boolean | 参数解释： 是否显示流水线源。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释： 自定义参数名称。 约束限制： 不涉及。 取值范围： 仅支持大小写英文字母、数字、“_”，不超过128个字符。 默认取值： 不涉及。 |
| sequence | 否 | Integer | 参数解释： 参数序号，从1开始。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| type | 否 | String | 参数解释： 自定义参数类型。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
| value | 否 | String | 参数解释： 自定义参数默认值。 约束限制： 不涉及。 取值范围： 最长8192字符。 默认取值： 不涉及。 |
| is_secret | 否 | Boolean | 参数解释： 是否私密参数。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
| description | 否 | String | 参数解释： 参数描述。 约束限制： 不涉及。 取值范围： 最长1024字符。 默认取值： 不涉及。 |
| is_runtime | 否 | Boolean | 参数解释： 是否运行时设置参数。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
| limits | 否 | Array of objects | 参数解释： 枚举值列表。 约束限制： 不涉及。 取值范围： 每个枚举值不超过1024字符。 默认取值： 不涉及。 |
| is_reset | 否 | Boolean | 参数解释： 是否重置。自增长参数被编辑，则使用编辑后的值，否则进行末位数字递增。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
| latest_value | 否 | String | 参数解释： 最近一次运行的参数值。 约束限制： 不涉及。 取值范围： 最长8192字符。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| templateId | String | 参数解释： 模板ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释： 错误信息。 取值范围： 不涉及。 |
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
请求示例
POST https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/pipeline-templates
{
"name" : "新建流水线模板-20231023215133",
"description" : "",
"language" : "none",
"is_show_source" : true,
"variables" : [ ],
"definition" : "{\"stages\":[{\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1698069093677,\"identifier\":\"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1\",\"name\":\"CodeCheck中文名称\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[{\"name\":\"CodeCheck中文名称\",\"task\":\"official_devcloud_codeCheck_template\",\"sequence\":0,\"inputs\":[{\"key\":\"language\",\"value\":\"Java\"},{\"key\":\"module_or_template_id\",\"value\":\"d7dffaefb6d94c63a09cf141668356c7\"}],\"business_type\":\"Gate\",\"runtime_attribution\":\"agent\",\"identifier\":\"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0\",\"multi_step_editable\":0,\"official_task_version\":\"0.0.1\"}],\"resource\":\"{\\\"type\\\":\\\"system\\\",\\\"arch\\\":\\\"x86\\\"}\",\"condition\":\"${{ completed() }}\",\"exec_type\":\"OCTOPUS_JOB\",\"sequence\":0}],\"identifier\":\"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}",
"domain_id" : "ce8df55870164338a72d7e828a966a2a",
"is_system" : false
} 响应示例
状态码：200
OK
{
"templateId" : "ad8a26f8b19a4b83a8d92eb733b65476"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。
