Help Center/ CodeArts Build/ API Reference/ Task APIs/ Querying a Build Template
Updated on 2024-04-18 GMT+08:00

Querying a Build Template

Function

This API is used to query a build template.

Calling Method

For details, see Calling APIs.

URI

GET /v3/templates/query

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Name of the template used for fuzzy query.

page

No

String

Page number, indicating that the query starts from this page.

page_size

No

String

Number of items displayed on each page. The value of page_size is less than or equal to 100.

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. (Value of X-Subject-Token in the response header.) Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

QueryTemplatesResult object

Template query result.

error

String

Returned error message.

status

String

Returned status information.

Table 4 QueryTemplatesResult

Parameter

Type

Description

total_size

Integer

Number of returned templates.

items

Array of QueryTemplatesItems objects

Template information.

Table 5 QueryTemplatesItems

Parameter

Type

Description

favourite

Boolean

Whether to favorite a template.

nick_name

String

Nickname.

id

String

ID in the database.

uuid

String

uuid

template

QueryTemplate object

Build action template, which is encapsulated in camel case.

type

String

Template type.

public

Boolean

Whether the template is public.

name

String

Template name.

create_time

String

Creation time.

domain_id

String

domainId

weight

Double

Weight.

user_id

String

User ID.

user_name

String

Username.

domain_name

String

Domain name.

scope

String

Template scope. For a user-defined template, the default value is custom.

description

String

Template description.

tool_type

String

Build tool type, which can be YAML build or action build.

intl_description

Object

intl description.

parameters

Array of CreateBuildJobParameter objects

Parameters for build execution.

i18n

Object

i18n

Table 6 QueryTemplate

Parameter

Type

Description

steps

Array of CreateBuildJobSteps objects

Build actions.

Table 7 CreateBuildJobSteps

Parameter

Type

Description

properties

Map<String,Object>

Build action.

module_id

String

Build module ID.

name

String

Build module name.

version

String

Build version.

enable

Boolean

Enable or not.

Table 8 CreateBuildJobParameter

Parameter

Type

Description

name

String

Parameter definition name. The default value is hudson.model.StringParameterDefinition.

params

Array of CreateBuildJobParameterParam objects

Subparameters of build execution parameters.

Table 9 CreateBuildJobParameterParam

Parameter

Type

Description

name

String

Parameter field name.

value

String

Parameter field value.

limits

Array of LimitsParam objects

Restrictions on enumeration parameters.

Table 10 LimitsParam

Parameter

Type

Description

disable

String

Whether the configuration takes effect. The default value is 0, indicating that the configuration takes effect.

display_name

String

Parameter display name.

name

String

Parameter name.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v3/templates/query?name=123

Example Responses

Status code: 200

OK

{
  "result" : {
    "total_size" : 172,
    "items" : [ {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "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" : "Code branch, which is a predefined parameter",
          "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" : { }
    }, {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "id" : "655593217c95e62ccee22799",
      "uuid" : "e6e1ac0c94254534bd6c952f201d621d",
      "template" : {
        "steps" : null
      },
      "type" : "codeci",
      "name" : "oych_test_sdk_template",
      "create_time" : "2023-11-16T03:57:21.333+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" : "oych_test_sdk_template",
      "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" : "Code branch, which is a predefined parameter",
          "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 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
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.*;


public class ListTemplatesSolution {

    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();
        ListTemplatesRequest request = new ListTemplatesRequest();
        request.withName("<name>");
        request.withPage("<page>");
        request.withPageSize("<page_size>");
        try {
            ListTemplatesResponse response = client.listTemplates(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = CodeArtsBuildClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTemplatesRequest()
        request.name = "<name>"
        request.page = "<page>"
        request.page_size = "<page_size>"
        response = client.list_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
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.ListTemplatesRequest{}
	nameRequest:= "<name>"
	request.Name = &nameRequest
	pageRequest:= "<page>"
	request.Page = &pageRequest
	pageSizeRequest:= "<page_size>"
	request.PageSize = &pageSizeRequest
	response, err := client.ListTemplates(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

500

Internal Server Error

Error Codes

See Error Codes.