All Products
Search
Document Center

Container Service for Kubernetes:DescribeTemplateAttribute

Last Updated:Feb 29, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeTemplateAttributeRead
  • All Resources
    *
    none
none

Request syntax

GET /templates/{TemplateId}

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdstringYes

The ID of the template.

874ec485-e7e6-4373-8a3b-47bde8a****
template_typestringNo

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

ParameterTypeDescriptionExample
object []

The details of the queried template.

idstring

The ID of the template. When you update a template, a new template ID is generated.

72d20cf8-a533-4ea9-a10d-e7630d3d****
aclstring

The access control policy of the template.

private
namestring

The name of the template.

web
templatestring

The template content in the YAML format.

apiVersion: V1\n***
template_typestring

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
descriptionstring

The description of the template.

test template
tagsstring

The label of the template.

sa
template_with_hist_idstring

The unique ID of the template. The value remains unchanged after the template is updated.

874ec485-e7e6-4373-8a3b-47bde8ae****
createdstring

The time when the template was created.

2020-09-16T19:21:29+08:00
updatedstring

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 timeSummary of changesOperation
No change history