创建流水线
功能介绍
创建流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
component_id |
否 |
String |
组件ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
流水线名称 |
description |
否 |
String |
流水线描述 |
is_publish |
是 |
Boolean |
是否为发布流水线 |
sources |
否 |
Array of CodeSource objects |
流水线源 |
variables |
否 |
Array of CustomVariable objects |
流水线自定义全局变量 |
schedules |
否 |
Array of PipelineSchedule objects |
流水线定时执行配置 |
triggers |
否 |
Array of PipelineTrigger objects |
流水线代码事件触发配置 |
manifest_version |
否 |
String |
流水线结构定义版本,新版默认为3.0 |
definition |
是 |
String |
流水线结构定义 |
project_name |
否 |
String |
项目名称 |
group_id |
否 |
String |
流水线组ID |
id |
否 |
String |
若为复制场景,则为原流水线ID |
concurrency_control |
否 |
PipelineConcurrencyMgmt object |
流水线并发管理 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
git_type |
否 |
String |
git类型 |
codehub_id |
否 |
String |
Repo代码仓ID |
endpoint_id |
否 |
String |
扩展点id |
default_branch |
否 |
String |
默认分支 |
git_url |
否 |
String |
git链接 |
ssh_git_url |
否 |
String |
ssh_git链接 |
web_url |
否 |
String |
网页url |
repo_name |
否 |
String |
流水线源名称 |
alias |
否 |
String |
代码仓别名。别名仅支持输入大小写英文字母、数字、“_”,至多128个字符 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_id |
否 |
String |
流水线ID |
name |
否 |
String |
自定义参数名称 |
sequence |
否 |
Integer |
自定义参数顺序 |
type |
否 |
String |
自定义参数类型 |
value |
否 |
String |
自定义参数默认值 |
is_secret |
否 |
Boolean |
是否私密参数 |
description |
否 |
String |
自定义参数描述 |
is_runtime |
否 |
Boolean |
是否运行时设置 |
limits |
否 |
Array of objects |
限定枚举值 |
is_reset |
否 |
Boolean |
是否重置 |
latest_value |
否 |
String |
最近一次参数值 |
runtime_value |
否 |
String |
运行时传入值 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
uuid |
否 |
String |
任务ID |
type |
否 |
String |
任务类型 |
name |
否 |
String |
任务名称 |
enable |
否 |
String |
是否可用 |
days_of_week |
否 |
Array of integers |
一周内具体时间 |
time_zone |
否 |
String |
时区 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_id |
否 |
String |
流水线ID |
git_url |
否 |
String |
git链接 |
git_type |
否 |
String |
git类型 |
is_auto_commit |
否 |
Boolean |
是否自动提交 |
events |
否 |
Array of CodeEvent objects |
事件 |
hook_id |
否 |
String |
回调id |
repo_id |
否 |
String |
仓库id |
endpoint_id |
否 |
String |
扩展点id |
callback_url |
否 |
String |
回调链接 |
security_token |
否 |
String |
用户token |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
pipeline_id |
String |
流水线ID |
请求示例
POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipelines { "name" : "新建流水线-20231024204112", "description" : "", "is_publish" : false, "sources" : [ { "type" : "code", "params" : { "git_type" : "codehub", "codehub_id" : "2111699317", "endpoint_id" : "", "default_branch" : "master", "git_url" : "https://example.com/0213yjw100001/0213yjw1-android.git", "ssh_git_url" : "git@example.com:0213yjw100001/0213yjw1-android.git", "web_url" : "", "repo_name" : "0213yjw1-android", "alias" : "" } } ], "definition" : "{\"stages\":[{\"id\":1698151278179,\"identifier\":\"169815127817987dd9f1d-7821-46e4-89be-2a95b01b0533\",\"run_always\":false,\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"id\":\"\",\"stage_id\":1698151278179,\"identifier\":\"1698151278179f6548479-2eaf-420a-92a4-92d9a711c51b\",\"name\":\"新建任务\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[],\"exec_type\":\"AGENTLESS_JOB\",\"sequence\":0}],\"rule_templates\":[],\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":[],\"depends_on\":[]}]}" }
响应示例
状态码: 200
OK
{ "pipeline_id" : "8bfbd69eac154a0da341705a36294aca" }
SDK代码示例
SDK代码示例如下。
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 |
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 CreatePipelineNewSolution { 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(); CreatePipelineNewRequest request = new CreatePipelineNewRequest(); request.withComponentId("<component_id>"); PipelineDTO body = new PipelineDTO(); CodeSourceParams paramsSources = new CodeSourceParams(); paramsSources.withGitType("codehub") .withCodehubId("2111699317") .withEndpointId("") .withDefaultBranch("master") .withGitUrl("https://example.com/0213yjw100001/0213yjw1-android.git") .withSshGitUrl("git@example.com:0213yjw100001/0213yjw1-android.git") .withWebUrl("") .withRepoName("0213yjw1-android") .withAlias(""); List<CodeSource> listbodySources = new ArrayList<>(); listbodySources.add( new CodeSource() .withType("code") .withParams(paramsSources) ); body.withDefinition("{"stages":[{"id":1698151278179,"identifier":"169815127817987dd9f1d-7821-46e4-89be-2a95b01b0533","run_always":false,"name":"阶段_1","sequence":"0","jobs":[{"id":"","stage_id":1698151278179,"identifier":"1698151278179f6548479-2eaf-420a-92a4-92d9a711c51b","name":"新建任务","depends_on":[],"timeout":"","timeout_unit":"","steps":[],"exec_type":"AGENTLESS_JOB","sequence":0}],"rule_templates":[],"pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":[],"depends_on":[]}]}"); body.withSources(listbodySources); body.withIsPublish(false); body.withDescription(""); body.withName("新建流水线-20231024204112"); request.withBody(body); try { CreatePipelineNewResponse response = client.createPipelineNew(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()); } } } |
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 |
# 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 = CreatePipelineNewRequest() request.component_id = "<component_id>" paramsSources = CodeSourceParams( git_type="codehub", codehub_id="2111699317", endpoint_id="", default_branch="master", git_url="https://example.com/0213yjw100001/0213yjw1-android.git", ssh_git_url="git@example.com:0213yjw100001/0213yjw1-android.git", web_url="", repo_name="0213yjw1-android", alias="" ) listSourcesbody = [ CodeSource( type="code", params=paramsSources ) ] request.body = PipelineDTO( definition="{"stages":[{"id":1698151278179,"identifier":"169815127817987dd9f1d-7821-46e4-89be-2a95b01b0533","run_always":false,"name":"阶段_1","sequence":"0","jobs":[{"id":"","stage_id":1698151278179,"identifier":"1698151278179f6548479-2eaf-420a-92a4-92d9a711c51b","name":"新建任务","depends_on":[],"timeout":"","timeout_unit":"","steps":[],"exec_type":"AGENTLESS_JOB","sequence":0}],"rule_templates":[],"pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":[],"depends_on":[]}]}", sources=listSourcesbody, is_publish=False, description="", name="新建流水线-20231024204112" ) response = client.create_pipeline_new(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.CreatePipelineNewRequest{} componentIdRequest:= "<component_id>" request.ComponentId = &componentIdRequest gitTypeParams:= "codehub" codehubIdParams:= "2111699317" endpointIdParams:= "" defaultBranchParams:= "master" gitUrlParams:= "https://example.com/0213yjw100001/0213yjw1-android.git" sshGitUrlParams:= "git@example.com:0213yjw100001/0213yjw1-android.git" webUrlParams:= "" repoNameParams:= "0213yjw1-android" aliasParams:= "" paramsSources := &model.CodeSourceParams{ GitType: &gitTypeParams, CodehubId: &codehubIdParams, EndpointId: &endpointIdParams, DefaultBranch: &defaultBranchParams, GitUrl: &gitUrlParams, SshGitUrl: &sshGitUrlParams, WebUrl: &webUrlParams, RepoName: &repoNameParams, Alias: &aliasParams, } typeSources:= "code" var listSourcesbody = []model.CodeSource{ { Type: &typeSources, Params: paramsSources, }, } definitionPipelineDto:= "{"stages":[{"id":1698151278179,"identifier":"169815127817987dd9f1d-7821-46e4-89be-2a95b01b0533","run_always":false,"name":"阶段_1","sequence":"0","jobs":[{"id":"","stage_id":1698151278179,"identifier":"1698151278179f6548479-2eaf-420a-92a4-92d9a711c51b","name":"新建任务","depends_on":[],"timeout":"","timeout_unit":"","steps":[],"exec_type":"AGENTLESS_JOB","sequence":0}],"rule_templates":[],"pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":[],"depends_on":[]}]}" isPublishPipelineDto:= false descriptionPipelineDto:= "" namePipelineDto:= "新建流水线-20231024204112" request.Body = &model.PipelineDto{ Definition: &definitionPipelineDto, Sources: &listSourcesbody, IsPublish: &isPublishPipelineDto, Description: &descriptionPipelineDto, Name: &namePipelineDto, } response, err := client.CreatePipelineNew(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 |
错误码
请参见错误码。