基于模板创建流水线
功能介绍
基于模板创建流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipeline-templates/{template_id}/create-pipeline
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： CodeArts项目ID。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
|
template_id |
是 |
String |
参数解释： 流水线模板ID。 约束限制： 不涉及。 取值范围： 32位字符，仅由数字和字母组成。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
component_id |
否 |
String |
参数解释： 流水线微服务ID。 约束限制： 不涉及。 取值范围： 32位字符，仅由数字和字母组成。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释： 流水线名称。 约束限制： 不涉及。 取值范围： 仅包含中文、大小写英文字母、数字、'-'和'_'，且长度为[1,128]个字符。 默认取值： 不涉及。 |
|
description |
否 |
String |
参数解释： 流水线描述。 约束限制： 不涉及。 取值范围： 最长1024字符。 默认取值： 不涉及。 |
|
is_publish |
是 |
Boolean |
参数解释： 是否为变更流水线。 约束限制： 不涉及。 取值范围： true - 变更流水线、false - 非变更流水线。 默认取值： 不涉及。 |
|
sources |
是 |
Array of CodeSource objects |
参数解释： 流水线源。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
variables |
否 |
Array of variables objects |
参数解释： 流水线参数列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
参数解释： 流水线源类型。 约束限制： 不涉及。 取值范围： 目前支持“code”代码源类型。 默认取值： 不涉及。 |
|
params |
否 |
params object |
参数解释： 流水线源参数，包含流水线源的详细信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
git_type |
否 |
String |
参数解释： 代码仓类型。 约束限制： 不涉及。 取值范围： 目前支持“codehub”，“gitee”，“github”，“gitcode”，“gitlab”代码仓类型。 默认取值： 不涉及。 |
|
codehub_id |
否 |
String |
参数解释： CodeArts Repo代码仓ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
endpoint_id |
否 |
String |
参数解释： 代码源扩展点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
default_branch |
否 |
String |
参数解释： 默认分支。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
git_url |
否 |
String |
参数解释： Git仓库https地址，例如https://example.com/CloudPipelinezycs00001/2000.git。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
ssh_git_url |
否 |
String |
参数解释： ssh_git链接地址，例如https://example.com/CloudPipelinezycs00001/2000.git。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
web_url |
否 |
String |
参数解释： 网页url。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
repo_name |
否 |
String |
参数解释： 流水线源名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
alias |
否 |
String |
参数解释： 代码仓别名。别名仅支持输入大小写英文字母、数字、“_”，至多128个字符。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
AnyType |
参数解释： 参数名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
sequence |
否 |
Integer |
参数解释： 参数序号，从1开始。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
type |
否 |
String |
参数解释： 参数类型。 约束限制： 不涉及。 取值范围： autoIncrement - 自增长参数，enum - 枚举参数，string - 字符串参数。 默认取值： 不涉及。 |
|
value |
否 |
String |
参数解释： 参数值。 约束限制： 不涉及。 取值范围： 最长8192字符。 默认取值： 不涉及。 |
|
is_secret |
否 |
Boolean |
参数解释： 是否私密参数。 约束限制： 不涉及。 取值范围： true - 是私密参数，false - 不是私密参数。 默认取值： false。 |
|
description |
否 |
String |
参数解释： 参数描述。 约束限制： 不涉及。 取值范围： 最长1024字符。 默认取值： 不涉及。 |
|
is_runtime |
否 |
Boolean |
参数解释： 是否运行时设置参数。 约束限制： 不涉及。 取值范围： true - 是运行时设置参数，false - 不是运行时设置参数。 默认取值： false。 |
|
is_reset |
否 |
Boolean |
参数解释： 是否重置。自增长参数被编辑，则使用编辑后的值，否则进行末位数字递增。 约束限制： 不涉及。 取值范围： true - 使用编辑后的参数值，false - 使用自增长参数。 默认取值： false |
|
latest_value |
否 |
String |
参数解释： 最后一次参数值。 约束限制： 不涉及。 取值范围： 最长8192字符。 默认取值： 不涉及。 |
|
limits |
否 |
Array of strings |
参数解释： 枚举值列表。 约束限制： 不涉及。 取值范围： 每个枚举值不超过1024字符。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pipeline_id |
String |
参数解释： 流水线ID。 取值范围： 32位字符，仅由数字和字母组成。 |
请求示例
基于模板创建流水线。
指定创建的流水线名称为”新建流水线-2023041516464511”，代码仓为”test001.git”，默认分支为”master”。
POST https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipeline-templates/434d660a96de423a935a0571c2223bca/create-pipeline
{
"name" : "新建流水线-2023041516464511",
"description" : "",
"is_publish" : false,
"sources" : [ {
"type" : "code",
"params" : {
"git_type" : "codehub",
"codehub_id" : "2111717853",
"endpoint_id" : "",
"default_branch" : "master",
"git_url" : "https://example.com/cjrTest00002/test001.git",
"ssh_git_url" : "git@example.com:cjrTest00002/test001.git",
"web_url" : "",
"repo_name" : "test001",
"alias" : ""
}
} ]
}响应示例
状态码：200
OK
{
"pipeline_id" : "ad6b7f66283a45be9c1f82b06c831e59"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
