# 运行yaml流水线 - RunPacPipeline #### 功能介绍 运行yaml流水线 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI POST /v6/{domain_id}/api/pac/pipelines/{pipeline_id}/run 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 租户ID，用户的domainId。 **约束限制**： 不涉及 **取值范围**： 32位字符。 **默认取值**： 不涉及。 | | pipeline_id | 是 | String | **参数解释**： 流水线ID，可以通过[查询流水线列表](https://support.huaweicloud.com/api-pipeline/ListPipelines.html)接口，其中pipelines.pipelineId即为流水线ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，仅由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sources | 否 | Array of [sources] objects | **参数解释**： 代码仓详情列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 运行描述。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | variables | 否 | Array of [variables] objects | **参数解释**： 参数列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | choose_jobs | 否 | Array of strings | **参数解释**： 运行选中任务列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | choose_stages | 否 | Array of strings | **参数解释**： 运行选中阶段列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3sources | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释**： 代码源类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | params | 否 | [params] object | **参数解释**： 参数详情。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4params | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | git_url | 否 | String | **参数解释**： 代码仓地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | git_type | 否 | String | **参数解释**： 代码仓类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ssh_git_url | 否 | String | **参数解释**： 代码仓ssh地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | web_url | 否 | String | **参数解释**： 网页跳转链接。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | repo_name | 否 | String | **参数解释**： 代码仓名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | codehub_id | 否 | String | **参数解释**： 代码仓id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | default_branch | 否 | String | **参数解释**： 默认分支。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | alias | 否 | String | **参数解释**： 代码仓别名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | endpoint_id | 否 | String | **参数解释**： 拓展点id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | build_params | 否 | [build_params] object | **参数解释**： 触发参数详情。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | change_request_ids | 否 | String | **参数解释**： 请求id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5build_params | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | build_type | 否 | String | **参数解释**： 构建类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | action | 否 | String | **参数解释**： 任务名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | commit_id | 否 | String | **参数解释**： 提交id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | event_type | 否 | String | **参数解释**： 触发方式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | merge_id | 否 | String | **参数解释**： MR触发的merge_id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | source_branch | 否 | String | **参数解释**： 源分支。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | message | 否 | String | **参数解释**： 触发信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | tag | 否 | String | **参数解释**： 触发标签。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | target_branch | 否 | String | **参数解释**： 目标分支。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | codehub_id | 否 | String | **参数解释**： 代码仓id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表6variables | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 参数名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | value | 否 | String | **参数解释**： 参数值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipeline_run_id | String | **参数解释**： 流水线运行实例ID。 **取值范围**： 32位字符，仅由数字和字母组成。 | #### 请求示例 ``` POST https://{endpoint}/v6/377c73ff41d54a5fb117b88ec0a60a33/api/pac/pipelines/{pipeline_id}/run { "sources" : [ { "type" : "code", "params" : { "git_type" : "codehub", "codehub_id" : "2111836036", "default_branch" : "master", "git_url" : "https://example.com/5c8305fa19154cabbb7f022a710f0ace/javaweb0127.git", "alias" : "", "endpoint_id" : "", "build_params" : { "build_type" : "branch", "event_type" : "Manual", "target_branch" : "master", "tag" : null } } } ], "description" : "", "variables" : [ ], "choose_jobs" : null, "choose_stages" : null } ``` #### 响应示例 **状态码：200** OK ``` { "pipeline_run_id" : "aeb40413c5444bdcbbf7a060873af7a7" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。