启动流水线
功能介绍
启动流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/run
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
pipeline_id |
是 |
String |
流水线ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sources |
否 |
Array of sources objects |
使用的源 |
description |
否 |
String |
运行描述 |
variables |
否 |
Array of variables objects |
使用的自定义参数 |
choose_jobs |
否 |
Array of strings |
选择的任务 |
choose_stages |
否 |
Array of strings |
选择的阶段 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
git_type |
是 |
String |
代码仓类型 |
alias |
否 |
String |
代码仓别名 |
codehub_id |
否 |
String |
Repo代码仓ID |
default_branch |
否 |
String |
默认分支 |
git_url |
是 |
String |
git仓库https地址 |
endpoint_id |
否 |
String |
扩展点ID |
build_params |
否 |
build_params object |
具体构建参数 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
pipeline_run_id |
String |
流水线运行实例ID |
请求示例
启动流水线。 指定运行的分支为”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代码示例如下。
启动流水线。 指定运行的分支为”master”,参数为”key:val”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
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("<YOUR REGION>")) .build(); RunPipelineRequest request = new RunPipelineRequest(); RunPipelineDTO body = new RunPipelineDTO(); List<String> listbodyChooseJobs = new ArrayList<>(); listbodyChooseJobs.add("16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4"); List<RunPipelineDTOVariables> listbodyVariables = new ArrayList<>(); listbodyVariables.add( new RunPipelineDTOVariables() .withName("key") .withValue("val") ); RunPipelineDTOParamsBuildParams buildParamsParams = new RunPipelineDTOParamsBuildParams(); buildParamsParams.withBuildType("branch") .withTargetBranch("test-lbdsb11") .withEventType("Manual"); RunPipelineDTOParams paramsSources = new RunPipelineDTOParams(); paramsSources.withGitType("codehub") .withCodehubId("2111699716") .withDefaultBranch("test-lbdsb11") .withGitUrl("https://example.com/clsyz00001/111.git") .withBuildParams(buildParamsParams); List<RunPipelineDTOSources> 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()); } } } |
启动流水线。 指定运行的分支为”master”,参数为”key:val”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# 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("<YOUR REGION>")) \ .build() try: request = RunPipelineRequest() listChooseJobsbody = [ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4" ] listVariablesbody = [ RunPipelineDTOVariables( name="key", value="val" ) ] buildParamsParams = RunPipelineDTOParamsBuildParams( build_type="branch", target_branch="test-lbdsb11", event_type="Manual" ) 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) |
启动流水线。 指定运行的分支为”master”,参数为”key:val”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.RunPipelineRequest{} var listChooseJobsbody = []string{ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4", } var listVariablesbody = []model.RunPipelineDtoVariables{ { Name: "key", Value: "val", }, } targetBranchBuildParams:= "test-lbdsb11" eventTypeBuildParams:= "Manual" buildParamsParams := &model.RunPipelineDtoParamsBuildParams{ BuildType: "branch", TargetBranch: &targetBranchBuildParams, EventType: &eventTypeBuildParams, } 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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。