更新时间:2024-09-04 GMT+08:00
分享

创建构建模板

功能介绍

创建构建模板

调用方法

请参见如何调用API

URI

POST /v3/templates/create

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不支持租户全局token,请使用scope为project的region级token。

取值范围

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

template

CreateTemplate object

构建步骤模板,需封装为驼峰式命名

name

String

模板命名

description

String

模板说明

tool_type

String

工具类型

parameters

Array of CreateBuildJobParameter objects

构建执行参数列表

表3 CreateTemplate

参数

是否必选

参数类型

描述

steps

Array of CreateTemplateSteps objects

构建执行的步骤

表4 CreateTemplateSteps

参数

是否必选

参数类型

描述

properties

Map<String,Object>

具体的构建步骤

module_id

String

构建模块id

name

String

构建模块名称

version

String

构建版本

enable

Boolean

是否开启

表5 CreateBuildJobParameter

参数

是否必选

参数类型

描述

name

String

参数定义名,默认为hudson.model.StringParameterDefinition

params

Array of CreateBuildJobParameterParam objects

构建执行参数子参数

表6 CreateBuildJobParameterParam

参数

是否必选

参数类型

描述

name

String

参数字段名

value

String

参数字段值

limits

Array of LimitsParam objects

枚举类参数限制

表7 LimitsParam

参数

是否必选

参数类型

描述

disable

String

是否生效,默认为"0",为生效状态

display_name

String

参数展示的名字

name

String

参数名字

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

result

CreateTemplatesItems object

查询模板结果

error

String

返回错误信息

status

String

返回状态信息

表9 CreateTemplatesItems

参数

参数类型

描述

favourite

Boolean

是否收藏模板

id

String

数据库中id

uuid

String

uuid

template

QueryTemplate object

构建步骤模板,需封装为驼峰式命名

type

String

模板类别

public

Boolean

模板是否公开

name

String

模板命名

create_time

String

创建时间

domain_id

String

domainId

weight

Double

权重

user_id

String

用户id

user_name

String

用户名

domain_name

String

domain名字

scope

String

模板范围,自定义模板默认为custom

description

String

模板说明

tool_type

String

构建工具类型,yaml构建还是action构建

intl_description

Object

intl说明

parameters

Array of CreateBuildJobParameter objects

构建执行参数列表

i18n

Object

i18n

表10 QueryTemplate

参数

参数类型

描述

steps

Array of CreateBuildJobSteps objects

构建执行的步骤

表11 CreateBuildJobSteps

参数

参数类型

描述

properties

Map<String,Object>

具体的构建步骤

module_id

String

构建模块id

name

String

构建模块名称

version

String

构建版本

enable

Boolean

是否开启

表12 CreateBuildJobParameter

参数

参数类型

描述

name

String

参数定义名,默认为hudson.model.StringParameterDefinition

params

Array of CreateBuildJobParameterParam objects

构建执行参数子参数

表13 CreateBuildJobParameterParam

参数

参数类型

描述

name

String

参数字段名

value

String

参数字段值

limits

Array of LimitsParam objects

枚举类参数限制

表14 LimitsParam

参数

参数类型

描述

disable

String

是否生效,默认为"0",为生效状态

display_name

String

参数展示的名字

name

String

参数名字

状态码: 400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v3/templates/create

{
  "name" : "example",
  "description" : "123",
  "tool_type" : "123123",
  "template" : {
    "steps" : [ {
      "module_id" : "devcloud2018.codeci_action_20043.action",
      "name" : "Maven构建",
      "enable" : true,
      "properties" : null
    } ]
  },
  "parameters" : [ {
    "name" : "hudson.model.StringParameterDefinition",
    "params" : [ {
      "name" : "name",
      "value" : "codeBranch"
    }, {
      "name" : "type",
      "value" : "normalparam"
    }, {
      "name" : "defaultValue",
      "value" : "master"
    }, {
      "name" : "description",
      "value" : "description"
    }, {
      "name" : "deletion",
      "value" : "false"
    }, {
      "name" : "defaults",
      "value" : "true"
    }, {
      "name" : "staticVar",
      "value" : "false"
    }, {
      "name" : "sensitiveVar",
      "value" : "false"
    } ]
  } ]
}

响应示例

状态码: 200

OK

{
  "result" : {
    "public" : true,
    "favourite" : false,
    "id" : "6561b2ced7a6751941fdc8cd",
    "uuid" : "2d9031c079624376824fe1e2731615dc",
    "template" : {
      "steps" : null
    },
    "type" : "codeci",
    "name" : "oych_test_temp_ladadad12122313",
    "create_time" : "2023-11-25T08:39:42.098+00:00",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "weight" : 0,
    "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
    "user_name" : "devcloud_codeci_z00485259_02",
    "domain_name" : "devcloud_codeci_z00485259_02",
    "scope" : "custom",
    "description" : "123",
    "intl_description" : { },
    "parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch",
        "limits" : null
      }, {
        "name" : "type",
        "value" : "normalparam",
        "limits" : null
      }, {
        "name" : "defaultValue",
        "value" : "master",
        "limits" : null
      }, {
        "name" : "description",
        "value" : "代码分支,系统预定义参数",
        "limits" : null
      }, {
        "name" : "deletion",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "defaults",
        "value" : "true",
        "limits" : null
      }, {
        "name" : "staticVar",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "sensitiveVar",
        "value" : "false",
        "limits" : null
      } ]
    } ],
    "i18n" : { }
  },
  "error" : null,
  "status" : "success"
}

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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
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.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateTemplatesSolution {

    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);

        CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateTemplatesRequest request = new CreateTemplatesRequest();
        CreateTemplatesRequestBody body = new CreateTemplatesRequestBody();
        List<CreateBuildJobParameterParam> listParametersParams = new ArrayList<>();
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("name")
                .withValue("codeBranch")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("type")
                .withValue("normalparam")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("defaultValue")
                .withValue("master")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("description")
                .withValue("description")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("deletion")
                .withValue("false")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("defaults")
                .withValue("true")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("staticVar")
                .withValue("false")
        );
        listParametersParams.add(
            new CreateBuildJobParameterParam()
                .withName("sensitiveVar")
                .withValue("false")
        );
        List<CreateBuildJobParameter> listbodyParameters = new ArrayList<>();
        listbodyParameters.add(
            new CreateBuildJobParameter()
                .withName("hudson.model.StringParameterDefinition")
                .withParams(listParametersParams)
        );
        List<CreateTemplateSteps> listTemplateSteps = new ArrayList<>();
        listTemplateSteps.add(
            new CreateTemplateSteps()
                .withModuleId("devcloud2018.codeci_action_20043.action")
                .withName("Maven构建")
                .withEnable(true)
        );
        CreateTemplate templatebody = new CreateTemplate();
        templatebody.withSteps(listTemplateSteps);
        body.withParameters(listbodyParameters);
        body.withToolType("123123");
        body.withDescription("123");
        body.withName("example");
        body.withTemplate(templatebody);
        request.withBody(body);
        try {
            CreateTemplatesResponse response = client.createTemplates(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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateTemplatesRequest()
        listParamsParameters = [
            CreateBuildJobParameterParam(
                name="name",
                value="codeBranch"
            ),
            CreateBuildJobParameterParam(
                name="type",
                value="normalparam"
            ),
            CreateBuildJobParameterParam(
                name="defaultValue",
                value="master"
            ),
            CreateBuildJobParameterParam(
                name="description",
                value="description"
            ),
            CreateBuildJobParameterParam(
                name="deletion",
                value="false"
            ),
            CreateBuildJobParameterParam(
                name="defaults",
                value="true"
            ),
            CreateBuildJobParameterParam(
                name="staticVar",
                value="false"
            ),
            CreateBuildJobParameterParam(
                name="sensitiveVar",
                value="false"
            )
        ]
        listParametersbody = [
            CreateBuildJobParameter(
                name="hudson.model.StringParameterDefinition",
                params=listParamsParameters
            )
        ]
        listStepsTemplate = [
            CreateTemplateSteps(
                module_id="devcloud2018.codeci_action_20043.action",
                name="Maven构建",
                enable=True
            )
        ]
        templatebody = CreateTemplate(
            steps=listStepsTemplate
        )
        request.body = CreateTemplatesRequestBody(
            parameters=listParametersbody,
            tool_type="123123",
            description="123",
            name="example",
            template=templatebody
        )
        response = client.create_templates(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
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient(
        codeartsbuild.CodeArtsBuildClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateTemplatesRequest{}
	nameParams:= "name"
	valueParams:= "codeBranch"
	nameParams1:= "type"
	valueParams1:= "normalparam"
	nameParams2:= "defaultValue"
	valueParams2:= "master"
	nameParams3:= "description"
	valueParams3:= "description"
	nameParams4:= "deletion"
	valueParams4:= "false"
	nameParams5:= "defaults"
	valueParams5:= "true"
	nameParams6:= "staticVar"
	valueParams6:= "false"
	nameParams7:= "sensitiveVar"
	valueParams7:= "false"
	var listParamsParameters = []model.CreateBuildJobParameterParam{
        {
            Name: &nameParams,
            Value: &valueParams,
        },
        {
            Name: &nameParams1,
            Value: &valueParams1,
        },
        {
            Name: &nameParams2,
            Value: &valueParams2,
        },
        {
            Name: &nameParams3,
            Value: &valueParams3,
        },
        {
            Name: &nameParams4,
            Value: &valueParams4,
        },
        {
            Name: &nameParams5,
            Value: &valueParams5,
        },
        {
            Name: &nameParams6,
            Value: &valueParams6,
        },
        {
            Name: &nameParams7,
            Value: &valueParams7,
        },
    }
	nameParameters:= "hudson.model.StringParameterDefinition"
	var listParametersbody = []model.CreateBuildJobParameter{
        {
            Name: &nameParameters,
            Params: &listParamsParameters,
        },
    }
	nameSteps:= "Maven构建"
	enableSteps:= true
	var listStepsTemplate = []model.CreateTemplateSteps{
        {
            ModuleId: "devcloud2018.codeci_action_20043.action",
            Name: &nameSteps,
            Enable: &enableSteps,
        },
    }
	templatebody := &model.CreateTemplate{
		Steps: listStepsTemplate,
	}
	toolTypeCreateTemplatesRequestBody:= "123123"
	descriptionCreateTemplatesRequestBody:= "123"
	request.Body = &model.CreateTemplatesRequestBody{
		Parameters: &listParametersbody,
		ToolType: &toolTypeCreateTemplatesRequestBody,
		Description: &descriptionCreateTemplatesRequestBody,
		Name: "example",
		Template: templatebody,
	}
	response, err := client.CreateTemplates(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

500

Internal Server Error

错误码

请参见错误码

相关文档