获取模板列表
功能介绍
根据提供的参数获取模板列表。
URI
GET /v2.1/templates
参数 |
是否必选 |
描述 |
---|---|---|
name |
否 |
模板名称,适用于根据模板名称查询模板ID场景。 |
offset |
否 |
查询起始偏移,默认为0。 |
limit |
否 |
单次查询总量,和offset必须成对出现。 |
dsl_version |
否 |
查询指定DSL版本的模板。 |
check_used |
否 |
是否检查模板的使用情况,如果为空默认false。 |
include_stack |
否 |
值为true时查询解决方案模板,为false时查询通用模板,为空时查询所有模板。 |
请求消息
N/A。
响应消息
- 响应参数
失败响应消息如表5所示。
表2 响应参数 参数
参数类型
描述
templates
Array of objects
数组元素为每个模板的所有版本详细信息,详情请参见表3。
total
Integer
模板总条数
表4 template字段数据结构说明 参数
参数类型
描述
id
String
模板ID
name
String
模板名称
version
String
模板版本
vendor
String
模板发布者
description
String
模板描述
template_url
String
模板包的存放地址
create_at
String
模板创建时间
update_at
String
模板更新时间
scope
String
模板可用范围
- project:项目内可用(现已不支持新建该范围的模板)
- domain:租户内可用
- public:全局可用(跨租户可用)
domain
String
模板所属租户名称
need_clutser
Boolean
判断模板是否需要CCE集群。当前AOS的应用都需要部署在CCE集群上。
dsl_version
String
模板的DSL版本
is_new_template
Boolean
模板是否是新模板
include_stack
Boolean
模板里面是否包含堆栈(AOS.Stack)元素
is_used
Boolean
检查模板是否在使用中(即存在使用此模板创建的堆栈),true表示在使用中。
表5 响应消息头 参数
是否必选
参数类型
取值范围
描述
Content-Range
否
String
具体取值依赖于用户的模板数量。
示例:items 0-24/66
分页信息,items为起始和终止,以及总数”。
- 响应示例
{ "templates": [ { "template": [ { "id": "74252143-4ca1-7ddb-d585-6be6786d1209", "name": "api-test", "version": "1.0", "vendor": "paas_aos_w00417971", "description": "", "template_url": "", "create_at": "2020-07-10T07:29:25Z", "update_at": "2020-07-14T11:07:09Z", "scope": "domain", "domain": "paas_aos_w00417971", "need_cluster": false, "dsl_version": "", "include_stack": false, "is_new_template": false, "is_used": false }, { "id": "34b159d8-cdf2-6764-e97b-8eb45b8e0f5b", "name": "api-test", "version": "1.1", "vendor": "paas_aos_w00417971", "description": "", "template_url": "", "create_at": "2020-07-14T11:05:36Z", "update_at": "2020-07-14T11:05:36Z", "scope": "domain", "domain": "paas_aos_w00417971", "need_cluster": false, "dsl_version": "", "include_stack": false, "is_new_template": false, "is_used": false } ] }, "total": 2 }
状态码
- 正常
表6 状态码 状态码
描述
200
查询模板列表成功。
- 异常
表7 状态码 状态码
描述
500
服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。