创建流水线

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

component_id

否

String

参数解释：

微服务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

用户Token。通过调用获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

是

String

参数解释：

流水线名称。

约束限制：

不涉及。

取值范围：

仅包含中文、大小写英文字母、数字、'-'和'_'，且长度为[1,128]个字符。

默认取值：

不涉及。

description

否

String

参数解释：

流水线描述。

约束限制：

不涉及。

取值范围：

不超过1024字符。

默认取值：

不涉及。

is_publish

是

Boolean

参数解释：

是否为变更流水线。

约束限制：

不涉及。

取值范围：

• true：变更流水线。

• false：非变更流水线。

默认取值：

不涉及。

sources

否

Array of CodeSource objects

参数解释：

流水线源信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

variables

否

Array of CustomVariable objects

参数解释：

流水线自定义全局变量列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

schedules

否

Array of PipelineSchedule objects

参数解释：

流水线定时执行配置列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

triggers

否

Array of PipelineTrigger objects

参数解释：

流水线代码事件触发配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

manifest_version

否

String

参数解释：

流水线结构定义版本。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

3.0。

definition

是

String

参数解释：

流水线结构定义JSON。该字段结构复杂，建议使用页面编辑流水线后，从查询流水线详情接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_name

否

String

参数解释：

项目名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

group_id

否

String

参数解释：

流水线组ID。

约束限制：

不涉及。

取值范围：

32位字符，仅由数字和字母组成。

默认取值：

不涉及。

id

否

String

参数解释：

复制场景使用，为流水线组ID。

约束限制：

不涉及。

取值范围：

32位字符，仅由数字和字母组成。

默认取值：

不涉及。

concurrency_control

否

PipelineConcurrencyMgmt object

参数解释：

流水线并发控制信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

流水线源类型。

约束限制：

不涉及。

取值范围：

• code：代码仓。

• artifact：制品仓。

默认取值：

不涉及。

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个字符。

默认取值：

不涉及。

pipeline_id

否

String

参数解释：

流水线ID，可以通过查询流水线列表接口，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

name

否

String

参数解释：

自定义参数名称。

约束限制：

不涉及。

取值范围：

仅支持大小写英文字母、数字、“_”，不超过128个字符。

默认取值：

不涉及。

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。

limits

否

Array of objects

参数解释：

枚举值列表。

约束限制：

不涉及。

取值范围：

每个枚举值不超过1024字符。

默认取值：

不涉及。

is_reset

否

Boolean

参数解释：

是否重置。自增长参数被编辑，则使用编辑后的值，否则进行末位数字递增。

约束限制：

不涉及。

取值范围：

• true：使用编辑后的参数值。

• false：使用自增长参数。

默认取值：

false。

latest_value

否

String

参数解释：

最近一次运行的参数值。

约束限制：

不涉及。

取值范围：

最长8192字符。

默认取值：

不涉及。

runtime_value

否

String

参数解释：

流水线运行时设置参数的传入值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

uuid

否

String

参数解释：

定时任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

任务类型。

约束限制：

不涉及。

取值范围：

• periodic：周期触发。

• fixed：时间间隔内周期触发。

默认取值：

不涉及。

name

否

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable

否

String

参数解释：

是否启用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

days_of_week

否

Array of integers

参数解释：

一周内具体执行日。周日至周六对应1-7。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

time_zone

否

String

参数解释：

时区。

约束限制：

不涉及。

取值范围：

• "China Standard Time"。

• "GMT Standard Time"。

• "South Africa Standard Time"。

• "Russian Standard Time"。

• "SE Asia Standard Time"。

• "Singapore Standard Time"。

• "Pacific SA Standard Time"。

• "E. South America Standard Time"。

• "Central Standard Time (Mexico)"。

• "Egypt Standard Time"。

• "Saudi Arabia Standard Time"。

默认取值：

不涉及。

pipeline_id

否

String

参数解释：

流水线ID，可以通过查询流水线列表接口，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

git_url

否

String

参数解释：

代码仓git链接。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

git_type

否

String

参数解释：

git代码仓类型。

约束限制：

不涉及。

取值范围：

• codehub。

• gitee。

• github。

• gitcode。

• gitlab。

默认取值：

不涉及。

is_auto_commit

否

Boolean

参数解释：

是否自动提交。gitee仓库特有，webhook触发流水线后，自动添加评论。

约束限制：

不涉及。

取值范围：

• true：是自动提交。

• false：不是自动提交。

默认取值：

不涉及。

events

否

Array of CodeEvent objects

参数解释：

触发事件列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

hook_id

否

String

参数解释：

系统生成的回调ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

repo_id

否

String

参数解释：

Repo仓库ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

endpoint_id

否

String

参数解释：

代码源扩展点ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

callback_url

否

String

参数解释：

回调链接，注册Webhook时生成。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

security_token

否

String

参数解释：

用户token，注册Webhook时生成。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

事件类型。

约束限制：

不涉及。

取值范围：

• merge_request：MR 触发。

• push：代码Push触发。

• tag_push：标签触发。

• issue：Gitee仓库ISSUE触发。

• note：Gitee仓库评论触发。

默认取值：

不涉及。

enable

否

Boolean

参数解释：

代码仓是否可用。

约束限制：

不涉及。

取值范围：

• true：代码仓可用。

• false：代码仓不可用。

默认取值：

不涉及。

pipeline_id

否

String

参数解释：

流水线ID，可以通过查询流水线列表接口，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

32位字符串。

默认取值：

不涉及。

concurrency_number

否

Integer

参数解释：

流水线并发个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

exceed_action

否

String

参数解释：

超出并发数时排队策略。

约束限制：

不涉及。

取值范围：

• ABORT：忽略不执行。

• QUEUE：排队等待。

默认取值：

不涉及。

create_time

否

Long

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

update_time

否

Long

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable

否

Boolean

参数解释：

是否启用。

约束限制：

不涉及。

取值范围：

• true：启用。

• false：未启用。

默认取值：

不涉及。

pipeline_id

String

参数解释：

流水线ID，可以通过查询流水线列表接口，其中pipelines.pipelineId即为流水线ID。

取值范围：

32位字符，仅由数字和字母组成。

200

OK

401

Unauthorized

403

Forbidden

404

Not Found