All Products
Search
Document Center

Container Service for Kubernetes:UpdateTemplate

Last Updated:Feb 29, 2024

You can call the UpdateTemplate operation to update an orchestration template by template ID.

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:UpdateTemplateWrite
  • All Resources
    *
    none
none

Request syntax

PUT /templates/{TemplateId}

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdstringYes

The ID of the template.

72d20cf8-a533-4ea9-a10d-e7630d3d2708
bodyobjectNo

The request body.

descriptionstringNo

The description of the template.

web server cluster
namestringNo

The name of the template.

webserver01
tagsstringNo

The label of the template.

web
templatestringNo

The YAML content of the 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: 8080
template_typestringNo

The type of template. This parameter can be set to 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.
kubernetes

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

Examples

Sample success responses

JSONformat

{}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history