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 can be obtained by calling the IAM service API. For details, seeObtaining 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.
resource_limit	ResourceLimit object	Definition Executor resource constraints. Constraints Resource constraints are enforced exclusively on custom executors of the Docker type. Range N/A. Default Value 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 false: Submodules are not updated. true: Submodules are updated.
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.

**Table 11** ResourceLimit
Parameter	Type	Description
cpu	String	Definition Maximum number of CPU cores. Constraints N/A. Range N/A. Default Value N/A.
memory	String	Definition Memory limit defined in MiB. Constraints N/A. Range N/A. Default Value N/A.

Example Requests

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

Example Responses

Status code: 200

{
  "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"
}