Updated on 2024-06-14 GMT+08:00

Creating a Pipeline Template

Function

This API is used to create a pipeline template.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Tenant ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Template name.

description

No

String

Template description.

language

Yes

String

Template language.

variables

No

CustomVariable object

Custom parameter.

definition

Yes

String

Template orchestration JSON file, including stages.

is_system

Yes

Boolean

System template or not.

domain_id

Yes

String

Tenant ID.

is_show_source

Yes

Boolean

Whether to display the pipeline source.

Table 4 CustomVariable

Parameter

Mandatory

Type

Description

pipeline_id

No

String

Pipeline ID.

name

No

String

Custom parameter name.

sequence

No

Integer

Custom parameter sequence.

type

No

String

Custom parameter type.

value

No

String

Default values of custom parameters.

is_secret

No

Boolean

Private parameter or not.

description

No

String

Custom parameter description.

is_runtime

No

Boolean

Runtime setting or not.

limits

No

Array of objects

Limited enumerated value.

is_reset

No

Boolean

Reset or not.

latest_value

No

String

Latest parameter value.

runtime_value

No

String

Runtime input value.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

templateId

String

Template ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

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

{
  "name" : "Creating a Pipeline Template-20231023215133",
  "description" : "",
  "language" : "none",
  "is_show_source" : true,
  "variables" : [ ],
  "definition" : "{\"stages\":[{\"name\":\"Phase _1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1698069093677,\"identifier\":\"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1\",\"name\":\"CodeCheck name\",\"depends_on\":[]] ,\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\": [{\"name\":\"CodeCheck name \",\"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
}

Example Responses

Status code: 200

OK

{
  "templateId" : "ad8a26f8b19a4b83a8d92eb733b65476"
}

SDK Sample Code

The SDK sample code is as follows.

 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":"Phase _1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck name","depends_on":[]] ,"timeout":"","timeout_unit":"","steps": [{"name":"CodeCheck name ","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("Creating a Pipeline Template-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":"Phase _1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck name","depends_on":[]] ,"timeout":"","timeout_unit":"","steps": [{"name":"CodeCheck name ","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="Creating a Pipeline Template-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":"Phase _1","sequence":"0","jobs":[{"stage_id":1698069093677,"identifier":"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1","name":"CodeCheck name","depends_on":[]] ,"timeout":"","timeout_unit":"","steps": [{"name":"CodeCheck name ","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: "Creating a Pipeline Template-20231023215133",
	}
	response, err := client.CreatePipelineTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.