查询模板列表

4.1.1 查询模板列表

功能介绍

查询模板列表，支持分页查询,支持模板名字模糊查询

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/templates 表4-1 Query 参数

参数 是否必选 参数类型 描述

template_type 是 String 模板类型 is_build_in 是 String 是否内置模板

offset 否 Integer 偏移量,表示从此偏移量开始查

询,offset大于等于0

limit 否 Integer 每页显示的条目数量

name 否 String 模板名称，匹配规则为模糊匹配

sort 否 String 排序字段

asc 否 String 是否正序

请求参数

表4-2 请求 Header 参数

参数 是否必选 参数类型 描述

X-Auth-Token 否 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。

X-Language 否 String 语言类型 中文:zh-cn 英文:en-us，默认en-us

响应参数

状态码： 200

表4-3 响应 Body 参数

参数 参数类型 描述

total Integer 总数 page_number Integer 页码数 page_size Integer 每页显示数 content Array of

TemplateVie w objects

模板数据,list类型数据

表4-4 TemplateView

参数 参数类型 描述

template_id String 模板ID template_na

me String 模板名字

template_type String 模板类型 template_url String 模板编辑URL user_id String 用户ID user_name String 用户名字 domain_id String 租户ID domain_name String 租户名字

参数 参数类型 描述

is_build_in Boolean 是否内置模板

region String 系统模板region为Cloud Pipeline。自定义模板 region为实际region

project_id String 项目ID project_name String 项目名字 create_time String 创建时间 last_modify_ti

me String 修改时间

is_watch Boolean 是否关注 description String 模板描述 parameter Array of

TemplatePar am objects

模板参数

flow Map<String,M ap<String,Stri

states Map<String,T emplateState

>

编排State详情，map类型数据。本字段为描述流 水线基础编排数据之一，建议可通过流水线真实 界面基于模板创建接口中获取

can_update Boolean 是否可以修改 can_delete Boolean 是否可以删除 need_hub Boolean 是否需要代码仓库

表4-5 TemplateParam

参数 参数类型 描述

required String 是否必须 visible String 是否可见

name String 流水线参数名字

value String 流水线参数值 description String 流水线参数描述

参数 参数类型 描述

paramtype String 流水线参数类型 display_type String 流水线参数展示类型 display_name String 流水线参数展示名字 is_static Boolean 是否静态参数 is_default Boolean 是否默认参数 limits Array of

ParamTypeLi mits objects

array类型数据

constraints Array of Constraint objects

array类型数据

表4-6 ParamTypeLimits

参数 参数类型 描述

disable String 是否废弃

name String 语言名字

displayname String 语言展示名字

id String 规则集ID

language String 扫描语言

表4-7 Constraint

参数 参数类型 描述

type String 校验规则类型

value String 校验规则 errormsg String 校验失败描述

表4-8 TemplateState

参数 参数类型 描述

type String 任务类型

name String 任务名字

参数 参数类型 描述 module_or_te

mplate_id String 模板任务ID module_or_te

mplate_name String 模板任务名字

display_name String 任务在流水线页面展示名字 dsl_method String 流水线可挂载任务类型 parameters Map<String,O

bject> 任务参数,map类型数据 is_manual_ex

ecution Boolean 是否手动执行 job_paramete

r_validate Boolean 任务参数是否校验 is_show_code

hub_url Boolean 是否显示代码仓URL is_execute Boolean 是否执行

job_id String 执行任务ID job_name String 执行任务名字 project_id String 任务所属项目ID execution_mo

de String 控制阶段下任务的串并行（type是task的 execution_mode值为null，type是stage的 execution_mode可选parallel（并行）或者serial

（串行））

状态码： 400

表4-9 响应 Body 参数

参数 参数类型 描述

error_msg String 错误信息 error_code String 错误码

请求示例

GET https://{endpoint}/v3/templates?template_type=pipeline&is_build_in=false&offset=0&limit=10

响应示例

无

状态码

状态码 描述

200 OK

400 Bad request 401 Unauthorized 403 Forbidden 404 Not Found

错误码

请参见错误码。