DescribeTemplateAttribute - Container Service for Kubernetes

An orchestration template defines and describes a group of Kubernetes resources. It declaratively describes the configuration of an application or how an application runs. You can call the DescribeTemplates API operation to query orchestration templates and their detailed information, including access permissions, YAML content, and labels.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribeTemplateAttribute	get	All Resources *	none	none

Request syntax

GET /templates/{TemplateId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The ID of the template.	874ec485-e7e6-4373-8a3b-47bde8a****
template_type	string	No	The type of template. The value can be a custom value. If the parameter is set to `kubernetes`, the template is displayed on the Templates page in the console. If the parameter is set to `compose`, the template is displayed on the Container Service - Swarm page in the console. Container Service for Swarm is deprecated. If the value of the parameter is not `kubernetes`, the template is not displayed on the Templates page in the console. We recommend that you set the parameter to `kubernetes`. Default value: `kubernetes`.	kubernetes

Response parameters

Parameter	Type	Description	Example
	array<object>	The details of the queried template.
template_info	object
id	string	The ID of the template. When you update a template, a new template ID is generated.	72d20cf8-a533-4ea9-a10d-e7630d3d****
acl	string	The access control policy of the template.	private
name	string	The name of the template.	web
template	string	The template content in the YAML format.	apiVersion: V1\n***
template_type	string	The type of template. The value can be a custom value. If the parameter is set to `kubernetes`, the template is displayed on the Templates page in the console. If the parameter is set to `compose`, the template is displayed on the Container Service - Swarm page in the console. Container Service for Swarm is deprecated. If the value of the parameter is not `kubernetes`, the template is not displayed on the Templates page in the console. We recommend that you set the parameter to `kubernetes`. Default value: `kubernetes`.	kubernetes
description	string	The description of the template.	test template
tags	string	The label of the template.	sa
template_with_hist_id	string	The unique ID of the template. The value remains unchanged after the template is updated.	874ec485-e7e6-4373-8a3b-47bde8ae****
created	string	The time when the template was created.	2020-09-16T19:21:29+08:00
updated	string	The time when the template was updated.	2020-09-16T19:21:29+08:00

Examples

Sample success responses

JSONformat

[
  {
    "id": "72d20cf8-a533-4ea9-a10d-e7630d3d****",
    "acl": "private",
    "name": "web",
    "template": "apiVersion: V1\\n***",
    "template_type": "kubernetes",
    "description": "test template",
    "tags": "sa",
    "template_with_hist_id": "874ec485-e7e6-4373-8a3b-47bde8ae****",
    "created": "2020-09-16T19:21:29+08:00",
    "updated": "2020-09-16T19:21:29+08:00"
  }
]

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history