文档首页 > > API参考> API> 查询模板列表

查询模板列表

分享
更新时间: 2019/08/26 GMT+08:00

功能介绍

根据提供的参数查询模板列表。

URI

GET /v2/templates

表1 参数说明

参数

是否必选

描述

scope

模板使用范围,如果为空默认domain。

name

模板名称,适用于根据模板名称查询模板ID场景。

vendor

模板作者。

offset

查询起始偏移,默认为0。

limit

单次查询总量,和offset必须成对出现。

dsl_version

查询指定DSL版本的模板。

check_used

是否检查模板的使用情况,如果为空默认false。

请求消息

N/A。

响应消息

  • 响应参数

    响应中含有多个模板结构,结构如表2所示。失败响应消息如表5所示。

    表2 模板结构

    参数

    参数类型

    描述

    id

    String

    模板ID

    name

    String

    模板名称

    version

    String

    模板版本

    vendor

    String

    模板发布者

    description

    String

    模板描述

    project_id

    String

    模板所属项目ID

    template_url

    String

    模板包的存放地址

    origin_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表示在使用中。

    is_new_template

    Boolean

    模板是否是新模板

    include_stack

    Boolean

    模板里面是否包含堆栈(AOS.Stack)元素

    表3 响应消息头

    参数

    是否必选

    参数类型

    描述

    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",
            "origin_template_url": "",
            "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",
            "origin_template_url": "",
            "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
        }
    ]

状态码

  • 正常
    表4 状态码

    状态码

    描述

    200

    查询模板列表成功。

  • 异常
    表5 状态码

    状态码

    描述

    500

    服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区