更新时间:2024-06-14 GMT+08:00

创建流水线模板

功能介绍

创建流水线模板

调用方法

请参见如何调用API

URI

POST /v5/{tenant_id}/api/pipeline-templates

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

String

租户ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

模板名称

description

String

模板描述

language

String

模板语言

variables

CustomVariable object

自定义参数

definition

String

模板编排json,包含stages

is_system

Boolean

是否系统模板

domain_id

String

所属租户ID

is_show_source

Boolean

是否显示流水线源

表4 CustomVariable

参数

是否必选

参数类型

描述

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

运行时传入值

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

templateId

String

模板ID

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

请求示例

POST https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/pipeline-templates

{
  "name" : "新建流水线模板-20231023215133",
  "description" : "",
  "language" : "none",
  "is_show_source" : true,
  "variables" : [ ],
  "definition" : "{\"stages\":[{\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1698069093677,\"identifier\":\"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1\",\"name\":\"CodeCheck中文名称\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[{\"name\":\"CodeCheck中文名称\",\"task\":\"official_devcloud_codeCheck_template\",\"sequence\":0,\"inputs\":[{\"key\":\"language\",\"value\":\"Java\"},{\"key\":\"module_or_template_id\",\"value\":\"d7dffaefb6d94c63a09cf141668356c7\"}],\"business_type\":\"Gate\",\"runtime_attribution\":\"agent\",\"identifier\":\"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0\",\"multi_step_editable\":0,\"official_task_version\":\"0.0.1\"}],\"resource\":\"{\\\"type\\\":\\\"system\\\",\\\"arch\\\":\\\"x86\\\"}\",\"condition\":\"completed()\",\"exec_type\":\"OCTOPUS_JOB\",\"sequence\":0}],\"identifier\":\"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "is_system" : false
}

响应示例

状态码: 200

OK

{
  "templateId" : "ad8a26f8b19a4b83a8d92eb733b65476"
}

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
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.*;


public class CreatePipelineTemplateSolution {

    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();
        CreatePipelineTemplateRequest request = new CreatePipelineTemplateRequest();
        PipelineTemplateDTO body = new PipelineTemplateDTO();
        body.withIsShowSource(true);
        body.withDomainId("ce8df55870164338a72d7e828a966a2a");
        body.withIsSystem(false);
        body.withDefinition("{"stages":[{"name":"阶段_1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck中文名称","depends_on":[],"timeout":"","timeout_unit":"","steps":[{"name":"CodeCheck中文名称","task":"official_devcloud_codeCheck_template","sequence":0,"inputs":[{"key":"language","value":"Java"},{"key":"module_or_template_id","value":"d7dffaefb6d94c63a09cf141668356c7"}],"business_type":"Gate","runtime_attribution":"agent","identifier":"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0","multi_step_editable":0,"official_task_version":"0.0.1"}],"resource":"{\"type\":\"system\",\"arch\":\"x86\"}","condition":"completed()","exec_type":"OCTOPUS_JOB","sequence":0}],"identifier":"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21","pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":null,"depends_on":[],"run_always":false}]}");
        body.withVariables("[]");
        body.withLanguage("none");
        body.withDescription("");
        body.withName("新建流水线模板-20231023215133");
        request.withBody(body);
        try {
            CreatePipelineTemplateResponse response = client.createPipelineTemplate(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
# 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 = CreatePipelineTemplateRequest()
        request.body = PipelineTemplateDTO(
            is_show_source=True,
            domain_id="ce8df55870164338a72d7e828a966a2a",
            is_system=False,
            definition="{"stages":[{"name":"阶段_1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck中文名称","depends_on":[],"timeout":"","timeout_unit":"","steps":[{"name":"CodeCheck中文名称","task":"official_devcloud_codeCheck_template","sequence":0,"inputs":[{"key":"language","value":"Java"},{"key":"module_or_template_id","value":"d7dffaefb6d94c63a09cf141668356c7"}],"business_type":"Gate","runtime_attribution":"agent","identifier":"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0","multi_step_editable":0,"official_task_version":"0.0.1"}],"resource":"{\"type\":\"system\",\"arch\":\"x86\"}","condition":"completed()","exec_type":"OCTOPUS_JOB","sequence":0}],"identifier":"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21","pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":null,"depends_on":[],"run_always":false}]}",
            variables="[]",
            language="none",
            description="",
            name="新建流水线模板-20231023215133"
        )
        response = client.create_pipeline_template(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
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.CreatePipelineTemplateRequest{}
	var variablesVariables interface{} = "[]"
	descriptionPipelineTemplateDto:= ""
	request.Body = &model.PipelineTemplateDto{
		IsShowSource: true,
		DomainId: "ce8df55870164338a72d7e828a966a2a",
		IsSystem: false,
		Definition: "{"stages":[{"name":"阶段_1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck中文名称","depends_on":[],"timeout":"","timeout_unit":"","steps":[{"name":"CodeCheck中文名称","task":"official_devcloud_codeCheck_template","sequence":0,"inputs":[{"key":"language","value":"Java"},{"key":"module_or_template_id","value":"d7dffaefb6d94c63a09cf141668356c7"}],"business_type":"Gate","runtime_attribution":"agent","identifier":"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0","multi_step_editable":0,"official_task_version":"0.0.1"}],"resource":"{\"type\":\"system\",\"arch\":\"x86\"}","condition":"completed()","exec_type":"OCTOPUS_JOB","sequence":0}],"identifier":"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21","pre":[{"task":"official_devcloud_autoTrigger","sequence":0}],"post":null,"depends_on":[],"run_always":false}]}",
		Variables: &variablesVariables,
		Language: "none",
		Description: &descriptionPipelineTemplateDto,
		Name: "新建流水线模板-20231023215133",
	}
	response, err := client.CreatePipelineTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码