更新时间:2022-02-22 GMT+08:00

查询模板

功能介绍

用于查询某个模板。

URI

GET /v2/templates/{template_id}

表1 参数说明

参数

是否必选

描述

template_id

模板id

请求消息

N/A。

响应消息

  • 响应参数

    失败的响应消息如表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)元素

  • 响应示例
    {
        "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": "2017-12-16T04:09:24Z",
        "update_at": "2017-12-16T04:09:26Z",
        "scope": "domain",
        "domain": "aos-team",
        "main_file_name": "blueprint.yaml",
        "need_cluster": true,
        "dsl_version": "cloud_tosca_version_"
      }

状态码

  • 正常
    表3 状态码

    状态码

    描述

    200

    查询模板成功

  • 异常
    表4 状态码

    状态码

    描述

    400

    请求参数有误

    404

    请求资源不存在