状态码
● 正常
表5-6 状态码
状态码 描述
201 模板创建成功。
● 异常
表5-7 状态码
状态码 描述
400 请求参数有误,当前请求无法被服务器解析。除非进行修改,
否则客户端不应重复提交这个请求。
409 因与被请求的资源当前状态之间存在冲突,请求无法完成。
500 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处
理。
5.2 查询模板列表
功能介绍
根据提供的参数查询模板列表。
URI
GET /v2/templates
表5-8 参数说明
参数 是否必选 描述
name 否 模板名称,适用于根据模板名称查询
模板ID场景。
参数 是否必选 描述
offset 否 查询起始偏移,默认为0。
limit 否 单次查询总量,和offset必须成对出
现。
dsl_version 否 查询指定DSL版本的模板。
check_used 否 是否检查模板的使用情况,如果为空
默认false。
include_stack 否 值为true时查询解决方案模板,为 false时查询通用模板,为空时查询所 有模板。
请求消息
N/A。
响应消息
● 响应参数
失败响应消息如表5-5所示。
表5-9 响应参数
参数 参数类型 描述
[数组元素] Array of objects 数组元素为模板详细信息,详情请参 见表5-10。
表5-10 模板详细信息
参数 参数类型 描述
id String 模板ID
name String 模板名称
version String 模板版本
vendor String 模板发布者
description String 模板描述 project_id String 模板所属项目ID template_url String 模板包的存放地址
converge_url String 模板的转化包地址,用于模板预览使 用。
参数 参数类型 描述
create_at String 模板创建时间 update_at String 模板更新时间
scope String 模板可用范围
● project:项目内可用(现已不支持 新建该范围的模板)
● domain:租户内可用
● public:全局可用(跨租户可用)
domain String 模板所属租户名称
main_file_name String 主文件名,为空使用默认值,为 blueprint.yaml。
need_clutser Boolean 判断模板是否需要CCE集群。当前AOS 的应用都需要部署在CCE集群上。
dsl_version String 模板的DSL版本
is_used Boolean 检查模板是否在使用中(即存在使用此 模板创建的堆栈),true表示在使用 中。
当查询参数check_used为true时,返回 值有该字段
is_new_template Boolean 模板是否是新模板
include_stack Boolean 模板里面是否包含堆栈(AOS.Stack)
元素
表5-11 响应消息头
参数 参数类型 描述
Content-Range String 分页信息,items为起始和终止,以及 总数”。具体取值依赖于用户的模板数 量。
示例:items 0-24/66
● 响应示例
[ {
"id": "f9f5839d-73e2-f22b-f20b-fb11bc1abb66", "name": "test-z",
"version": "v1", "vendor": "aos-team", "description": "", "project_id": "",
"template_url": "https://swr-api-server.manage.svc.cluster.local:20202/swr/v2/domains/aos-team/
namespaces/aos-teame002/repositories/stack_templates/packages/test-z/versions/v1/file_paths/test-staless-container.tar.gz",
"converge_url": "https://swr-api-server.manage.svc.cluster.local:20202/swr/v2/domains/aos-team/
namespaces/aos-teame002/repositories/stack_templates/packages/test-z/versions/v1/file_paths/test-z-v1-converge.tar.gz",
"create_at": "2018-12-16T01:15:39Z", "update_at": "2018-12-16T01:15:41Z", "scope": "domain",
"domain": "aos-team",
"main_file_name": "blueprint.yaml", "need_cluster": true,
"dsl_version": "huaweicloud_tosca_version_", "is_used": true,
"is_new_template": false, "include_stack": false },
{
"id": "fd3f1e6d-cc93-c3c3-d015-f69c3ff3bc63", "name": "test-z",
"version": "v2", "vendor": "aos-team", "description": "", "project_id": "",
"template_url": "https://swr-api-server.manage.svc.cluster.local:20202/swr/v2/domains/aos-team/
namespaces/aos-teame002/repositories/stack_templates/packages/test-z/versions/v2/file_paths/
blueprint.zip",
"converge_url": "https://swr-api-server.manage.svc.cluster.local:20202/swr/v2/domains/aos-team/
namespaces/aos-teame002/repositories/stack_templates/packages/test-z/versions/v2/file_paths/test-z-v2-converge.tar.gz",
"create_at": "2018-12-16T04:09:24Z", "update_at": "2018-12-16T04:09:26Z", "scope": "domain",
"domain": "aos-team",
"main_file_name": "blueprint.yaml", "need_cluster": true,
"dsl_version": "huaweicloud_tosca_version_", "is_used": true,
"is_new_template": false, "include_stack": false }
]
状态码
● 正常
表5-12 状态码
状态码 描述
200 查询模板列表成功。
● 异常
表5-13 状态码
状态码 描述
500 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处
理。