Updated on 2025-08-21 GMT+08:00

Querying Build Templates

Function

This API is used to query build templates.

Calling Method

For details, see Calling APIs.

URI

GET /v3/templates/query

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition

Name of the template used for fuzzy query.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

page

No

String

Definition

The index of the page to start the query from.

Constraints

N/A.

Range

Use only numbers that are 0 or greater.

page_size

No

String

Definition

page_size indicates the number of items displayed on each page. The value is no more than 100.

Constraints

N/A.

Range

1–100

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token.

Constraints

Global tenant tokens are not supported. Use a region-level token whose scope is project.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

QueryTemplatesResult object

Definition

Template query result.

Range

N/A.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

success: The API call is successful.

fail: The API call failed.

Table 4 QueryTemplatesResult

Parameter

Type

Description

total_size

Integer

Definition

Number of returned templates.

Range

N/A.

items

Array of QueryTemplatesItems objects

Definition

Template information list.

Range

N/A.

Table 5 QueryTemplatesItems

Parameter

Type

Description

favourite

Boolean

Definition

Whether a template is favorited.

Range

true: The template is favorited.

false: The template is not added to favorites.

nick_name

String

Definition

Nickname.

Range

N/A.

id

String

Definition

Primary key ID in the database.

Range

N/A.

uuid

String

Definition

Template ID.

Range

N/A.

template

QueryTemplateVo object

Definition

Build action template. It is named using the camel case convention.

Range

N/A.

type

String

Definition

Template type.

Range

N/A.

public

Boolean

Definition

Whether the template is public.

Range

true: Public.

false: Non-public.

name

String

Definition

Template name.

Range

N/A.

create_time

String

Definition

Time when the template was created.

Range

N/A.

domain_id

String

Definition

Tenant ID.

Range

N/A.

weight

Double

Definition

Weight.

Range

N/A.

user_id

String

Definition

User ID.

Range

N/A.

user_name

String

Definition

Username.

Range

N/A.

domain_name

String

Definition

Tenant name.

Range

N/A.

scope

String

Definition

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

Range

N/A.

description

String

Definition

Template description.

Range

N/A.

tool_type

String

Definition

Build tool type. It indicates if the build is defined by YAML or actions.

Range

N/A.

intl_description

Object

Definition

intl description.

Range

N/A.

parameters

Array of CreateBuildJobParameterResponse objects

Definition

A list of build execution parameters.

Range

N/A.

i18n

Object

Definition

Internationalization (i18n).

Range

N/A.

Table 6 QueryTemplateVo

Parameter

Type

Description

steps

Array of CreateBuildJobStepsResponse objects

Definition

Build actions being executed.

Range

N/A.

actions

Object

Definition

Build actions.

Range

N/A.

auto_update_sub_module

Boolean

Definition

Whether submodules are automatically updated.

Range

N/A.

image

String

Definition

Image address.

Range

N/A.

image_source

String

Definition

Image source address.

Range

N/A.

Table 7 CreateBuildJobStepsResponse

Parameter

Type

Description

properties

Map<String,Object>

Definition

Build action parameters.

Range

N/A.

module_id

String

Definition

Build action ID.

Range

N/A.

name

String

Definition

Build action name.

Range

N/A.

version

String

Definition

Build action version.

Range

N/A.

enable

Boolean

Definition

Whether to enable automatic build task.

Range

true: Enabled.

false: Disabled.

Table 8 CreateBuildJobParameterResponse

Parameter

Type

Description

name

String

Definition

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

Range

N/A.

params

Array of CreateBuildJobParameterParamResponse objects

Definition

Subparameters of build execution parameters.

Range

N/A.

Table 9 CreateBuildJobParameterParamResponse

Parameter

Type

Description

name

String

Definition

Parameter field name.

Range

N/A.

value

String

Definition

Parameter field value.

Range

N/A.

limits

Array of LimitsParamResponse objects

Definition

Restrictions on enumeration parameters.

Range

N/A.

Table 10 LimitsParamResponse

Parameter

Type

Description

disable

String

Definition

Whether enabled or not. The default value is 0, indicating "enabled".

Range

N/A.

display_name

String

Definition

Parameter display name.

Range

N/A.

name

String

Definition

Parameter name.

Range

N/A.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

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" : "testUser",
      "domain_name" : "testUser",
      "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, predefined parameters",
          "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
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();
        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
# 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 = ListTemplatesRequest()
        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
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{}
	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.