# 启动流水线 - RunPipeline #### 功能介绍 启动流水线 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/run 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-pipeline/pipeline_03_0036.html)。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | | pipeline_id | 是 | String | **参数解释**： 流水线ID，可以通过[查询流水线列表](https://support.huaweicloud.com/api-pipeline/ListPipelines.html)接口获取，其中pipelines.pipelineId即为流水线ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用[IAM服务获取用户Token接口](https://support.huaweicloud.com/api-iam/iam_30_0003.html)获取（响应消息头中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。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4sources | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 流水线源类型，目前支持"code"、"artifact"等代码源类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | params | 否 | [params] object | **参数解释**： 流水线源相关参数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5params | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | git_type | 是 | String | **参数解释**： 代码仓类型。 **约束限制**： 不涉及。 **取值范围**： - codehub。 - gitee - github - gitcode - gitlab - git。 **默认取值**： 不涉及。 | | 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。可以通过[查询扩展点列表接口](https://support.huaweicloud.com/api-pipeline/ListEndpointsDetails.html)获取，其中endpoints.uuid即为扩展点的唯一标识。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | build_params | 否 | [build_params] object | **参数解释**： 流水线具体构建参数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | change_request_ids | 否 | Array of strings | **参数解释**： 执行变更流水线变更ID列表。可以通过[查询变更列表](https://support.huaweicloud.com/api-pipeline/ListChangeRequests.html)接口，其中data.id即为变更ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表6build_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 | **参数解释**： 流水线触发运行的标签。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表7variables | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 参数名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | value | 是 | String | **参数解释**： 参数值。 **约束限制**： 不涉及。 **取值范围**： 不超过8192字符。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipeline_run_id | String | **参数解释**： 流水线运行实例ID，[启动流水线](https://support.huaweicloud.com/api-pipeline/RunPipeline.html)接口的返回值即为流水线运行实例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" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 启动流水线。 指定运行的分支为"master"，参数为"key:val"。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; import java.util.List; import java.util.ArrayList; public class RunPipelineSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("")) .build(); RunPipelineRequest request = new RunPipelineRequest(); request.withProjectId("{project_id}"); request.withPipelineId("{pipeline_id}"); RunPipelineDTO body = new RunPipelineDTO(); List listbodyChooseJobs = new ArrayList<>(); listbodyChooseJobs.add("16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4"); List listbodyVariables = new ArrayList<>(); listbodyVariables.add( new RunPipelineDTOVariables() .withName("key") .withValue("val") ); RunPipelineDTOParamsBuildParams buildParamsParams = new RunPipelineDTOParamsBuildParams(); buildParamsParams.withBuildType("branch") .withEventType("Manual") .withTargetBranch("test-lbdsb11"); RunPipelineDTOParams paramsSources = new RunPipelineDTOParams(); paramsSources.withGitType("codehub") .withCodehubId("2111699716") .withDefaultBranch("test-lbdsb11") .withGitUrl("https://example.com/clsyz00001/111.git") .withBuildParams(buildParamsParams); List listbodySources = new ArrayList<>(); listbodySources.add( new RunPipelineDTOSources() .withType("code") .withParams(paramsSources) ); body.withChooseJobs(listbodyChooseJobs); body.withVariables(listbodyVariables); body.withDescription("流水线运行描述"); body.withSources(listbodySources); request.withBody(body); try { RunPipelineResponse response = client.runPipeline(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 启动流水线。 指定运行的分支为"master"，参数为"key:val"。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("")) \ .build() try: request = RunPipelineRequest() request.project_id = "{project_id}" request.pipeline_id = "{pipeline_id}" listChooseJobsbody = [ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4" ] listVariablesbody = [ RunPipelineDTOVariables( name="key", value="val" ) ] buildParamsParams = RunPipelineDTOParamsBuildParams( build_type="branch", event_type="Manual", target_branch="test-lbdsb11" ) paramsSources = RunPipelineDTOParams( git_type="codehub", codehub_id="2111699716", default_branch="test-lbdsb11", git_url="https://example.com/clsyz00001/111.git", build_params=buildParamsParams ) listSourcesbody = [ RunPipelineDTOSources( type="code", params=paramsSources ) ] request.body = RunPipelineDTO( choose_jobs=listChooseJobsbody, variables=listVariablesbody, description="流水线运行描述", sources=listSourcesbody ) response = client.run_pipeline(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 启动流水线。 指定运行的分支为"master"，参数为"key:val"。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartspipeline.NewCodeArtsPipelineClient(hcClient) request := &model.RunPipelineRequest{} request.ProjectId = "{project_id}" request.PipelineId = "{pipeline_id}" var listChooseJobsbody = []string{ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4", } var listVariablesbody = []model.RunPipelineDtoVariables{ { Name: "key", Value: "val", }, } eventTypeBuildParams:= "Manual" targetBranchBuildParams:= "test-lbdsb11" buildParamsParams := &model.RunPipelineDtoParamsBuildParams{ BuildType: "branch", EventType: &eventTypeBuildParams, TargetBranch: &targetBranchBuildParams, } codehubIdParams:= "2111699716" defaultBranchParams:= "test-lbdsb11" paramsSources := &model.RunPipelineDtoParams{ GitType: "codehub", CodehubId: &codehubIdParams, DefaultBranch: &defaultBranchParams, GitUrl: "https://example.com/clsyz00001/111.git", BuildParams: buildParamsParams, } var listSourcesbody = []model.RunPipelineDtoSources{ { Type: "code", Params: paramsSources, }, } descriptionRunPipelineDto:= "流水线运行描述" request.Body = &model.RunPipelineDto{ ChooseJobs: &listChooseJobsbody, Variables: &listVariablesbody, Description: &descriptionRunPipelineDto, Sources: &listSourcesbody, } response, err := client.RunPipeline(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsPipeline/sdk?api=RunPipeline)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。