Listing Templates

Function

ListTemplates

This API lists all your templates at the current region.

By default, the templates are sorted by creation time. The template created latest is displayed on the top.
If no template is available, an empty list will be returned.
To obtain details about template versions, call ListTemplateVersions.
Support pagination. If there is next_marker in the response, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to get the next part of the outputs. You should repeat this until the next_marker response is set to null.

ListTemplates returns only summaries of templates. You can obtain details about the summaries by referring to ListTemplatesResponseBody. For details about a particular template, call ShowTemplateMetadata.

URI

GET /v1/{project_id}/templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. It can be obtained by calling an API or from the console. Obtaining a Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Pagination marker. When a single page cannot return all results, the previous request will return a next_marker to indicate there are more pages. Users can place the value of next_marker here to query information from the next page. This marker can only be used for requests with the same parameters as the previous request. If not specified, the query will start from the first page by default.
limit	No	Integer	The maximum number of results to return per page

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Client-Request-Id	Yes	String	Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
templates	Array of Template objects	Template list.
page_info	PageInfo object	Pagination information

**Table 5** Template
Parameter	Type	Description
template_id	String	Unique template ID. It is randomly generated by the template service.
template_name	String	Name of a template. The name is unique within its domain (domain_id) and region. Chinese characters, letters, digits, underscores (_), and hyphens (-) are allowed. It is case-sensitive and must start with a Chinese character or a letter.
template_description	String	Template description. It can be used by users to identify their own templates.
create_time	String	Creation time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.
update_time	String	Update time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.
latest_version_id	String	ID of the latest template version.
latest_version_description	String	Description of the latest template version.

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Forward pagination identifier. Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to get the next part of the outputs. You should repeat this until the next_marker response is set to null.
previous_marker	String	Backward pagination identifier.
current_count	Integer	The number of items returned on current page.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 8** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 10** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 12** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 429

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 14** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 16** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Example Requests

List all your templates at the current region.

GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates

Example Responses

Status code: 200

Templates listed.

{
  "templates" : [ {
    "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8",
    "template_name" : "my_first_template",
    "template_description" : "Template description",
    "create_time" : "2023-05-09T08:00:00Z",
    "update_time" : "2023-05-09T09:00:00Z",
    "latest_version_description" : "Latest version description",
    "latest_version_id" : "V10"
  }, {
    "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c9",
    "template_name" : "my_second_template",
    "template_description" : "Description",
    "create_time" : "2023-05-09T09:00:00Z",
    "update_time" : "2023-05-09T10:00:00Z",
    "latest_version_description" : "Latest version description",
    "latest_version_id" : "V10"
  } ],
  "page_info" : {
    "next_marker" : null,
    "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks=",
    "current_count" : 2
  }
}

Status Codes

Status Code	Description
200	Templates listed.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
429	Too frequent requests.
500	Internal server error.