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

查询官方模板

功能介绍

查询官方模板。

调用方法

请参见如何调用API

URI

GET /v1/template/officialtemplates

表1 Query参数

参数

是否必选

参数类型

描述

name

String

参数解释

检索的模板的名字模糊查询。

约束限制

不涉及。

取值范围

支持中英文,数字,下划线“_”和连接符“-”;字符长度范围为1~115。

默认取值

不涉及。

page

String

参数解释

分页页码, 表示从此页开始查询。

约束限制

不涉及。

取值范围

0-2147483647

默认取值:

0

page_size

String

参数解释

每页显示的条目数量。

约束限制

不涉及。

取值范围

1-100。

默认取值:

20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释

返回的数据。

取值范围

不涉及。

error

String

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

● success:表示接口调用成功。

● fail:表示接口调用失败。

表4 result

参数

参数类型

描述

total_size

Number

参数解释

返回的数据总条数。

取值范围

不涉及。

items

Array of TemplateList objects

参数解释

模板列表。

取值范围

不涉及。

表5 TemplateList

参数

参数类型

描述

language

String

参数解释

模板支持的语言。

取值范围

不涉及。

favourite

Boolean

参数解释

是否收藏模板。

取值范围

● true:表示收藏模板。

● false:表示不收藏模板。

uuid

String

参数解释

模板唯一标识。

取值范围

不涉及。

type

String

参数解释

模板类别。

取值范围

不涉及。

name

String

参数解释

模板名称。

取值范围

不涉及。

weight

Double

参数解释

权重。

取值范围

不涉及。

scope

String

参数解释

模板范围,自定义模板默认为:custom,官方模板为:official。

取值范围

不涉及。

description

String

参数解释

模板说明。

取值范围

不涉及。

nick_name

String

参数解释

昵称。

取值范围

不涉及。

public

Boolean

参数解释

模板是否公开。

取值范围

● true:表示模板公开。

● false:表示模板不公开。

tool_type

String

参数解释

构建工具类型,mono、npm、maven等。

取值范围

mono、npm、maven等。

template

QueryTemplate object

参数解释

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

取值范围

不涉及。

parameters

Array of Parameter objects

参数解释

构建执行参数列表。

取值范围

不涉及。

表6 QueryTemplate

参数

参数类型

描述

steps

Array of CreateBuildJobStepsResponse objects

参数解释

构建执行的步骤。

取值范围

不涉及。

表7 CreateBuildJobStepsResponse

参数

参数类型

描述

properties

Map<String,Object>

参数解释

构建步骤配置参数。

取值范围

不涉及。

module_id

String

参数解释

构建步骤ID。

取值范围

不涉及。

name

String

参数解释

构建步骤名称。

取值范围

不涉及。

version

String

参数解释

构建步骤版本。

取值范围

不涉及。

enable

Boolean

参数解释

是否开启自动构建任务。

取值范围

● true:开启。

● false:不开启。

表8 Parameter

参数

参数类型

描述

name

String

参数解释

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

取值范围

不涉及。

params

Array of CreateBuildJobParameterParamResponse objects

参数解释

构建执行参数子参数。

取值范围

不涉及。

表9 CreateBuildJobParameterParamResponse

参数

参数类型

描述

name

String

参数解释

参数字段名。

取值范围

不涉及。

value

String

参数解释

参数字段值。

取值范围

不涉及。

limits

Array of LimitsParamResponse objects

参数解释

枚举类参数限制。

取值范围

不涉及。

表10 LimitsParamResponse

参数

参数类型

描述

disable

String

参数解释

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

取值范围

不涉及。

display_name

String

参数解释

参数展示的名字。

取值范围

不涉及。

name

String

参数解释

参数名字。

取值范围

不涉及。

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/template/officialtemplates

响应示例

状态码:200

OK

{
  "result" : {
    "items" : [ {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "uuid" : "2d9031c079624376824fe1e2731615dc",
      "template" : {
        "steps" : null
      },
      "type" : "codeci",
      "name" : "oych_test_temp_ladadad12122313",
      "weight" : 0,
      "scope" : "custom",
      "description" : "123",
      "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
        } ]
      } ]
    }, {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "uuid" : "e6e1ac0c94254534bd6c952f201d621d",
      "template" : {
        "steps" : null
      },
      "type" : "codeci",
      "name" : "oych_test_sdk_template",
      "weight" : 0,
      "scope" : "custom",
      "description" : "oych_test_sdk_template",
      "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
        } ]
      } ]
    } ],
    "total_size" : 41
  },
  "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
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 ListOfficialTemplateSolution {

    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();
        ListOfficialTemplateRequest request = new ListOfficialTemplateRequest();
        try {
            ListOfficialTemplateResponse response = client.listOfficialTemplate(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 = ListOfficialTemplateRequest()
        response = client.list_official_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
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.ListOfficialTemplateRequest{}
	response, err := client.ListOfficialTemplate(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

错误码

请参见错误码

相关文档