Querying a Template

Function

This API is used to query a template.

URI

GET /v2/templates/{template_id}

**Table 1** Parameter description
Parameter	Mandatory	Description
template_id	Yes	Template ID

Request

N/A

Response

Response parameters

Response messages when the request fails are listed in Table 5.

**Table 2** Response parameters
Parameter	Type	Description
id	String	Template ID.
name	String	Template name.
version	String	Template version.
vendor	String	Template publisher.
description	String	Template description.
project_id	String	ID of the project to which the template belongs.
template_url	String	URL where the template package is stored.
origin_template_url	String	Original URL of the template package.
converge_url	String	URL of the template conversion package, which is used for template preview.
create_at	String	Template creation time.
update_at	String	Template update time.
scope	String	Template application scope. project: available within a project (Currently, templates of this scope cannot be created anymore.) domain: available within an account public: available globally, namely, available between accounts
domain	String	Name of the account to which the template belongs.
main_file_name	String	Name of the main file. If this parameter is left blank, the default value blueprint.yaml is used.
need_clutser	Boolean	Determine whether Cloud Container Engine (CCE) clusters are required. Currently, all AOS applications must be deployed on CCE clusters.
dsl_version	String	DSL version of the template.
is_used	Boolean	Check whether the template is in use (that is, check whether there are any stack created using this template). If the value of this parameter is true, the template is in use.
is_new_template	Boolean	Whether it is a new template.
include_stack	Boolean	Whether the template contains stack elements (AOS.Stack).

Example response

{
    "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_"
  }