查询构建模板
功能介绍
查询构建模板。
调用方法
请参见如何调用API。
URI
GET /v3/templates/query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释: 检索的模板的名字模糊查询。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
page |
否 |
String |
参数解释: 分页页码, 表示从此页开始查询。 约束限制: 不涉及。 取值范围: 只能使用数字,大于等于0。 默认取值: 1 |
page_size |
否 |
String |
参数解释: 每页显示的条目数量,page_size小于等于100。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
QueryTemplatesResult object |
参数解释: 查询模板结果。 取值范围: 不涉及。 |
error |
String |
参数解释: 返回错误信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
total_size |
Integer |
参数解释: 返回模板数量。 取值范围: 不涉及。 |
items |
Array of QueryTemplatesItems objects |
参数解释: 模板信息列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
favourite |
Boolean |
参数解释: 是否收藏模板。 取值范围: ● true:收藏模板。 ● false:未收藏模板。 |
nick_name |
String |
参数解释: 昵称。 取值范围: 不涉及。 |
id |
String |
参数解释: 数据库中的主键id。 取值范围: 不涉及。 |
uuid |
String |
参数解释: 模板ID。 取值范围: 不涉及。 |
template |
QueryTemplateVo object |
参数解释: 构建步骤模板,需封装为驼峰式命名。 取值范围: 不涉及。 |
type |
String |
参数解释: 模板类别。 取值范围: 不涉及。 |
public |
Boolean |
参数解释: 模板是否公开。 取值范围: ● true:公开。 ● false:不公开。 |
name |
String |
参数解释: 模板命名。 取值范围: 不涉及。 |
create_time |
String |
参数解释: 模板创建时间。 取值范围: 不涉及。 |
domain_id |
String |
参数解释: 租户ID。 取值范围: 不涉及。 |
weight |
Double |
参数解释: 权重。 取值范围: 不涉及。 |
user_id |
String |
参数解释: 用户id。 取值范围: 不涉及。 |
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
domain_name |
String |
参数解释: 租户名称。 取值范围: 不涉及。 |
scope |
String |
参数解释: 模板范围,自定义模板默认为custom。 取值范围: 不涉及。 |
description |
String |
参数解释: 模板说明。 取值范围: 不涉及。 |
tool_type |
String |
参数解释: 构建工具类型,yaml构建还是action构建。 取值范围: 不涉及。 |
intl_description |
Object |
参数解释: intl说明。 取值范围: 不涉及。 |
parameters |
Array of CreateBuildJobParameterResponse objects |
参数解释: 构建执行参数列表。 取值范围: 不涉及。 |
i18n |
Object |
参数解释: i18n。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
steps |
Array of CreateBuildJobStepsResponse objects |
参数解释: 构建执行的步骤。 取值范围: 不涉及。 |
actions |
Object |
参数解释: 构建步骤中的action。 取值范围: 不涉及。 |
auto_update_sub_module |
Boolean |
参数解释: 是否自动更新子模块。 取值范围: 不涉及。 |
image |
Boolean |
参数解释: 配置镜像地址。 取值范围: 不涉及。 |
image_source |
Boolean |
参数解释: 配置镜像源的地址。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
properties |
Map<String,Object> |
参数解释: 构建步骤配置参数。 取值范围: 不涉及。 |
module_id |
String |
参数解释: 构建步骤ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 构建步骤名称。 取值范围: 不涉及。 |
version |
String |
参数解释: 构建步骤版本。 取值范围: 不涉及。 |
enable |
Boolean |
参数解释: 是否开启自动构建任务。 取值范围: ● true:开启。 ● false:不开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数定义名,默认为hudson.model.StringParameterDefinition。 取值范围: 不涉及。 |
params |
Array of CreateBuildJobParameterParamResponse objects |
参数解释: 构建执行参数子参数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数字段名。 取值范围: 不涉及。 |
value |
String |
参数解释: 参数字段值。 取值范围: 不涉及。 |
limits |
Array of LimitsParamResponse objects |
参数解释: 枚举类参数限制。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
disable |
String |
参数解释: 是否生效,默认为"0",为生效状态。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 参数展示的名字。 取值范围: 不涉及。 |
name |
String |
参数解释: 参数名字。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v3/templates/query?name=123
响应示例
状态码: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代码示例
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 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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的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 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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。