ModifyTemplate - Elastic Desktop Service - Alibaba Cloud Documentation Center

Modifies a custom cloud computer template.

Operation description

Warning This operation employs the full parameter update logic to maintain compatibility between the no-configuration logic and the default update logic. In other words, any unspecified parameters are treated as empty.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
ecd:ModifyTemplate	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	b-0caoeogs88y*****
TemplateName	string	No	The template name. It must meet the following criteria: It can be 2 to 126 characters in length. It must begin with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). Note: Periods (.) are not supported in the name.
Description	string	No	The template description. It must meet the following criteria: It can be 2 to 256 characters in length and cannot start with `http://` or `https://`. It can contain letters, digits, and special characters, including spaces. Note: You can use carriage returns to break lines.	testDescription
SystemDiskSize	integer	No	The size of the system disk. Unit: GiB. Valid values: 40 to 500. Increments: 10 GiB. Note The system disk size must be at least as large as the configured image size.	80
SystemDiskPerformanceLevel	string	No	The performance level (PL) of the system disk. Note Only cloud computers of the Graphics or High Frequency type support Enterprise SSDs (ESSDs). Valid values: PL1: a PL1 ESSD. PL0: a PL0 ESSD. AutoPL: an AutoPL ESSD.	AutoPL
DataDiskList	array<object>	No
	object	No
Size	integer	No	The size of the data disk. Unit: GiB.Valid range: 40 to 2040 GiB with an increment of 10 GiB.	40
PerformanceLevel	string	No	The PL of the data disk. Default value: `AutoPL`. Valid values: PL1: a PL1 ESSD PL0: a PL0 ESSD AutoPL: an AutoPL ESSD
ImageId	string	No	The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.	m-gx2x1dhsmusr2****
PolicyGroupId	string	No	The ID of the policy group.	pg-gx2x1dhsmthe9****
DefaultLanguage	string	No	The default language of the cloud computer during startup. This parameter takes effect only when the cloud computer is created from a system image. Valid values: en-US: English. zh-HK: Chinese, Traditional (Hong Kong, China). zh-CN: Simplified Chinese. ja-JP: Japanese.	zh-CN
TimerGroupId	string	No	The ID of the scheduled task group.	bcc-dweha*****
ResourceGroupId	string	No	The ID of the resource group.	rg-a5fqjjqaejt***
ResourceTagList	array<object>	No	The tags added to cloud computers. Specify tags in key-value pairs. You can specify up to 20 tags.
	object	No
Key	string	No	The tag key.	department
Value	string	No	The tag value.	design
RegionConfigList	array<object>	No	The regions by which you can search for cloud computer templates. When this parameter takes effect, cloud computer templates are matched based on the specified regions. Note You can specify up to 20 regions.
	object	No
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-beijing
SnapshotPolicyId	string	No	The ID of the automatic snapshot policy.	sp-35fvn8m2*****
ResourceInstanceType	string	No	The ID of the cloud computer type.	eds.enterprise_office.8c16g
VolumeEncryptionEnable	boolean	No	Specifies whether to enable disk encryption. Valid values: false (default): disables disk encryption. true: enables disk encryption.	false
VolumeEncryptionKey	string	No	The ID of the Key Management Service (KMS) key that you want to use to encrypt disks.	a7b3c0c8-b3a2-4876-b1cc-116dddc9****
OfficeSiteId	string	No	The office network ID.	cn-hangzhou+dir-709****
SubnetId	string	No	The subnet ID.	vsw-adjrehad1****

Response parameters

Parameter	Type	Description	Example
	object	BaseResult
Success	boolean	Indicates whether the operation is successful. Valid values: true false	true
Code	string	The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.	success
Message	string	The error message returned. This parameter is not returned if the value of Code is `success`.	success
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Code": "success",
  "Message": "success",
  "HttpStatusCode": 200,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-12-25	The internal configuration of the API is changed, but the call is not affected	View Change Details