文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 根据条件查询特定模板
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据条件查询特定模板

功能介绍

根据条件查询特定模板

调用方法

请参见如何调用API。

URI

GET /v1/template/custom

表1 Query参数

参数

是否必选

参数类型

描述

name

否

String

名称

filter

否

String

过滤条件

page

否

Integer

分页页码，表示从此页开始查询，page大于等于1

page_size

否

Integer

每页显示的条目数量，page_size小于等于100

tags

否

String

构建状态过滤条件

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

result

QueryCustomTemplatesResult object

查询自定义模板结果

error

String

返回错误信息

status

String

返回状态信息
表3 QueryCustomTemplatesResult

参数

参数类型

描述

total_size

Integer

返回模板数量

items

Array of QueryTemplatesItems objects

模板信息列表
表4 QueryTemplatesItems

参数

参数类型

描述

favourite

Boolean

是否收藏模板

nick_name

String

昵称

id

String

数据库中id

uuid

String

uuid

template

QueryTemplate object

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

type

String

模板类别

public

Boolean

模板是否公开

name

String

模板命名

create_time

String

创建时间

domain_id

String

domainId

weight

Double

权重

user_id

String

用户id

user_name

String

用户名

domain_name

String

domain名字

scope

String

模板范围，自定义模板默认为custom

description

String

模板说明

tool_type

String

构建工具类型，yaml构建还是action构建

intl_description

Object

intl说明

parameters

Array of CreateBuildJobParameter objects

构建执行参数列表

i18n

Object

i18n
表5 QueryTemplate

参数

参数类型

描述

steps

Array of CreateBuildJobSteps objects

构建执行的步骤
表6 CreateBuildJobSteps

参数

参数类型

描述

properties

Map<String,Object>

构建步骤属性参数

module_id

String

构建步骤id

name

String

构建步骤名称

version

String

构建步骤版本

enable

Boolean

是否开启
表7 CreateBuildJobParameter

参数

参数类型

描述

name

String

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

params

Array of CreateBuildJobParameterParam objects

构建执行参数子参数
表8 CreateBuildJobParameterParam

参数

参数类型

描述

name

String

参数字段名

value

String

参数字段值

limits

Array of LimitsParam objects

枚举类参数限制
表9 LimitsParam

参数

参数类型

描述

disable

String

是否生效，默认为"0"，为生效状态

display_name

String

参数展示的名字

name

String

参数名字

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/template/custom?name=test&filter=&page=1&page_size=10

响应示例

状态码： 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"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档