查询模板详情(待下线)
功能介绍
查询模板详情
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/templates/{template_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template_id |
是 |
String |
模板ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template_type |
是 |
String |
模板类型 |
source |
否 |
String |
接口调用方 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Language |
否 |
String |
语言类型 中文:zh-cn 英文:en-us,默认en-us |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
template_id |
String |
模板ID |
template_name |
String |
模板名字 |
template_type |
String |
模板类型 |
user_id |
String |
用户ID |
user_name |
String |
用户名字 |
domain_id |
String |
租户ID |
domain_name |
String |
租户名字 |
is_build_in |
Boolean |
是否内置模板 |
region |
String |
region |
project_id |
String |
项目ID |
project_name |
String |
项目名字 |
create_time |
String |
创建时间 |
last_modify_time |
String |
修改时间 |
is_watch |
Boolean |
是否关注 |
description |
String |
模板描述 |
parameter |
Array of TemplateParam objects |
模板参数 |
flow |
Map<String,Map<String,String>> |
编排flow详情,描述流水线内各阶段任务的串并行关系。map类型数据,key为阶段名字,默认第一阶段initial,最后阶段为final,其余名字以'state_数字'标识。value为该阶段内任务(以'Task_数字'标识)以及后续阶段的标识。本字段为描述流水线基础编排数据之一,建议可通过流水线真实界面基于模板创建接口中获取 |
states |
Map<String,TemplateState> |
编排State详情,map类型数据。本字段为描述流水线基础编排数据之一,建议可通过流水线真实界面基于模板创建接口中获取 |
参数 |
参数类型 |
描述 |
---|---|---|
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 ParamTypeLimits objects |
array类型数据 |
constraints |
Array of Constraint objects |
array类型数据 |
参数 |
参数类型 |
描述 |
---|---|---|
disable |
String |
是否废弃 |
name |
String |
语言名字 |
displayname |
String |
语言展示名字 |
id |
String |
规则集ID |
language |
String |
扫描语言 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
任务类型 |
name |
String |
任务名字 |
module_or_template_id |
String |
模板任务ID |
module_or_template_name |
String |
模板任务名字 |
display_name |
String |
任务在流水线页面展示名字 |
dsl_method |
String |
流水线可挂载任务类型 |
parameters |
Map<String,Object> |
任务参数,map类型数据 |
is_manual_execution |
Boolean |
是否手动执行 |
job_parameter_validate |
Boolean |
任务参数是否校验 |
is_show_codehub_url |
Boolean |
是否显示代码仓URL |
is_execute |
Boolean |
是否执行 |
job_id |
String |
执行任务ID |
job_name |
String |
执行任务名字 |
project_id |
String |
任务所属项目ID |
execution_mode |
String |
控制阶段下任务的串并行(type是task的execution_mode值为null,type是stage的execution_mode可选parallel(并行)或者serial(串行)) |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v3/templates/6efb0b24e2e9489eb0e53ee12904a19e?template_type=deployMan
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
