启动流水线
功能介绍
启动流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/run
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
pipeline_id |
是 |
String |
参数解释: 流水线ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
参数解释: 流水线源类型。 约束限制: 不涉及。 取值范围: 目前支持“code”代码源类型。 默认取值: 不涉及。 |
params |
否 |
params object |
源参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
git_type |
是 |
String |
参数解释: 代码仓类型。 约束限制: 不涉及。 取值范围: 目前支持codhub,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 |
参数解释: 具体构建参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
build_type |
是 |
String |
参数解释: 代码仓触发类型。 约束限制: 不涉及。 取值范围: branch - 分支触发,tag - 标签触发。 默认取值: 不涉及。 |
target_branch |
否 |
String |
参数解释: 流水线触发运行分支。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
tag |
否 |
String |
参数解释: 流水线触发运行标签。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
event_type |
否 |
String |
参数解释: 流水线触发事件类型。 约束限制: 不涉及。 取值范围: Manual - 手动触发,Scheduler - 定时任务触发,RollBack - 回滚执行,以及WebHook类型:CreateTag - Tag 触发,Note - Gitee仓库评论触发,Issue - Gitee 仓库Issue触发,MR - 合并请求触发,Push - 代码push触发。 默认取值: Manual手动运行。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
pipeline_run_id |
String |
参数解释: 流水线运行实例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代码示例如下。
启动流水线。 指定运行的分支为”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 |
错误码
请参见错误码。