Queries all application deployment templates.
Debugging
Request syntax
GET /templates?template_type=String&page_num=Long&page_size=Long HTTP/1.1
Content-Type:application/json
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
template_type | String | Yes | kubernetes |
The type of the templates that you want to query. You can set the parameter to a custom value.
Default value: |
page_num | Long | No | 1 |
The number of the page to return. Default value: 1. |
page_size | Long | No | 10 |
The number of entries to return on each page. Default value: 10. |
Response syntax
HTTP/1.1 200
Content-Type:application/json
{
"templates" : [ {
"acl" : "String",
"id" : "String",
"name" : "String",
"description" : "String",
"tags" : "String",
"template" : "String",
"template_type" : "String",
"created" : "String",
"updated" : "String",
"template_with_hist_id" : "String"
} ],
"page_info" : {
"page_number" : Long,
"page_size" : Long,
"total_count" : Long
}
}
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
templates | Array of template |
The list of the templates returned . |
|
acl | String | private |
The access control policy of the template. Valid values:
Default value: |
id | String | 874ec485-e7e6-4373-8a3b-47bde8ae789f |
The ID of the template. |
name | String | webserver |
The name of the template. |
description | String | a web server |
The description of the template. |
tags | String | kubernetes |
The tag of the template. By default, the value is the name of the template. |
template | String | apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: nginx-deployment-basic\n labels:\n app: nginx\nspec:\n replicas: 2\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n spec:\n containers:\n - name: nginx\n image: busybox:latest\n ports:\n - containerPort: 80 |
The template content in YAML format. |
template_type | String | kubernetes |
The type of the template. The value can be a custom value.
|
created | String | 2020-06-10T16:30:16+08:00 |
The time when the template was created. |
updated | String | 2020-06-10T16:30:16+08:00 |
The time when the template was updated. |
template_with_hist_id | String | ad81d115-7c8b-47e7-a222-9c28d7f6e588 |
The ID of the parent template. The value of |
page_info | object |
The pagination details. |
|
page_number | Long | 20 |
The page number of the returned page. |
page_size | Long | 3 |
The maximum number of entries returned per page. |
total_count | Long | 50 |
The total number of entries returned. |
Examples
Sample requests
GET /templates?template_type=kubernetes&page_num=1&page_size=10 HTTP/1.1
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<templates>
<acl>private</acl>
<id>874ec485-e7e6-4373-8a3b-47bde8ae789f</id>
<name>webserver</name>
<description>a web server</description>
<tags>kubernetes</tags>
<template>apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: nginx-deployment-basic\n labels:\n app: nginx\nspec:\n replicas: 2\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n spec:\n containers:\n - name: nginx\n image: busybox:latest\n ports:\n - containerPort: 80</template>
<template_type>kubernetes</template_type>
<created>2020-06-10T16:30:16+08:00</created>
<updated>2020-06-10T16:30:16+08:00</updated>
<template_with_hist_id>ad81d115-7c8b-47e7-a222-9c28d7f6e588</template_with_hist_id>
</templates>
<page_info>
<page_number>20</page_number>
<page_size>3</page_size>
<total_count>50</total_count>
</page_info>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"templates" : [ {
"acl" : "private",
"id" : "874ec485-e7e6-4373-8a3b-47bde8ae789f",
"name" : "webserver",
"description" : "a web server",
"tags" : "kubernetes",
"template" : "apiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n name: nginx-deployment-basic\\n labels:\\n app: nginx\\nspec:\\n replicas: 2\\n selector:\\n matchLabels:\\n app: nginx\\n template:\\n metadata:\\n labels:\\n app: nginx\\n spec:\\n containers:\\n - name: nginx\\n image: busybox:latest\\n ports:\\n - containerPort: 80",
"template_type" : "kubernetes",
"created" : "2020-06-10T16:30:16+08:00",
"updated" : "2020-06-10T16:30:16+08:00",
"template_with_hist_id" : "ad81d115-7c8b-47e7-a222-9c28d7f6e588"
} ],
"page_info" : {
"page_number" : 20,
"page_size" : 3,
"total_count" : 50
}
}
Error codes
For a list of error codes, visit the API Error Center.