文档首页/ 流水线 CodeArts Pipeline/ API参考（联盟区域）/ API/ 流水线管理/ 启动流水线
更新时间：2026-01-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

启动流水线

功能介绍

启动流水线

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/run

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

sources

否

Array of sources objects

参数解释：

代码源信息列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

description

否

String

参数解释：

流水线运行描述。

约束限制：

不涉及。

取值范围：

不超过1024字符。

默认取值：

不涉及。

variables

否

Array of variables objects

参数解释：

使用的自定义参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

choose_jobs

否

Array of strings

参数解释：

流水线运行时选择的流水线任务。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

choose_stages

否

Array of strings

参数解释：

选择的流水线阶段。优先级高于choose_jobs，即stage未选择时，无视choose_jobs中该stage下的job。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 sources

参数

是否必选

参数类型

描述

type

是

String

参数解释：

流水线源类型，目前支持“code”、“artifact”等代码源类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

params

否

params object

参数解释：

流水线源相关参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 params

参数

是否必选

参数类型

描述

git_type

是

String

参数解释：

代码仓类型。

约束限制：

不涉及。

取值范围：

  • codehub。

  • gitee。

  • github。

  • gitcode。

  • gitlab。

默认取值：

不涉及。

alias

否

String

参数解释：

代码仓别名，用户自定义，用于多仓时帮助区分系统参数。例如：A_REPO_COMMIT_ID，B_REPO_COMMIT_ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

codehub_id

否

String

参数解释：

CodeArts Repo代码仓ID。可以通过代码仓查询接口获取，代码仓的唯一标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

default_branch

否

String

参数解释：

流水线执行时代码仓默认分支。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

git_url

是

String

参数解释：

Git仓库https地址，例如https://example.com/CloudPipelinezycs00001/2000.git。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

endpoint_id

否

String

参数解释：

代码源扩展点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

build_params

否

build_params object

参数解释：

流水线具体构建参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

change_request_ids

否

Array of strings

参数解释：

执行变更流水线变更ID列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表6 build_params

参数

是否必选

参数类型

描述

build_type

是

String

参数解释：

代码仓触发类型，包含branch-分支触发，tag-标签触发等。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

event_type

否

String

参数解释：

流水线的触发方式。

  • Manual：手动触发。

  • Scheduler：定时任务。

  • MR：MR触发。

  • Push：Push事件触发。

  • CreateTag：Tag事件触发。

  • Issue：Issue触发。

  • Note：评论触发。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

target_branch

否

String

参数解释：

流水线触发运行分支。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tag

否

String

参数解释：

流水线触发运行的标签。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表7 variables

参数

是否必选

参数类型

描述

name

是

String

参数解释：

参数名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

是

String

参数解释：

参数值。

约束限制：

不涉及。

取值范围：

不超过8192字符。

默认取值：

不涉及。

响应参数

状态码：200

表8 响应Body参数

参数

参数类型

描述

pipeline_run_id

String

参数解释：

流水线运行实例ID，启动流水线接口的返回值即为流水线运行实例ID。

取值范围：

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

请求示例

启动流水线。

指定运行的分支为”master”，参数为”key:val”。

POST https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/e5460d1d403146a1935c2d4b68ef506c/run

{
  "sources" : [ {
    "type" : "code",
    "params" : {
      "git_type" : "codehub",
      "codehub_id" : "2111699716",
      "default_branch" : "test-lbdsb11",
      "git_url" : "https://example.com/clsyz00001/111.git",
      "build_params" : {
        "build_type" : "branch",
        "event_type" : "Manual",
        "target_branch" : "test-lbdsb11"
      }
    }
  } ],
  "description" : "流水线运行描述",
  "variables" : [ {
    "name" : "key",
    "value" : "val"
  } ],
  "choose_jobs" : [ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4" ]
}

响应示例

状态码：200

OK

{
  "pipeline_run_id" : "ad6b7f66283a45be9c1f82b06c831e59"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 流水线管理