Update Cloud Computer Templates with ModifyTemplate API - Elastic Desktop Service

Modifies all parameters of a custom WUYING Workspace template.

Operation description

Warning This operation updates all parameters. To ensure compatibility with the default upgrade logic, any parameter that you do not specify is set to empty.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	b-0caoeogs88y*****
TemplateName	string	No	The name of the template. The name must meet the following requirements: It must be 2 to 126 characters in length. It must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain letters, digits, Chinese characters, colons (:), underscores (_), and hyphens (-). It cannot contain periods (.).	我的云电脑模板001
Description	string	No	The description of the template. The description must meet the following requirements: It must be 2 to 256 characters in length. It cannot start with `http://` or `https://`. It can contain Chinese characters, letters, digits, spaces, and special characters. Use line breaks to start a new line.	testDescription
SystemDiskSize	integer	No	The size of the system disk. Unit: GiB. The value must be between 40 and 500, inclusive. The step size is 10 GiB. Note The system disk size cannot be smaller than the size of the image.	80
SystemDiskPerformanceLevel	string	No	The type of the system disk. Note Enhanced SSD (ESSD) disks are supported only by cloud computers with high clock speeds and powerful graphics capabilities. Valid values: PL1 : An ESSD cloud disk at performance level 1. PL0 : An ESSD cloud disk at performance level 0. AutoPL : An ESSD cloud disk that automatically adjusts its performance level.	AutoPL
DataDiskList	array<object>	No
	object	No
Size	integer	No	The size of the data disk. Unit: GiB. The value must be between 40 and 2040, inclusive. The step size is 10 GiB.	40
PerformanceLevel	string	No	The performance level of the data disk. The default value is `AutoPL`. Valid values: PL1 : ESSD PL1 PL0 : ESSD PL0 AutoPL : ESSD AutoPL
ImageId	string	No	The ID of the WUYING Workspace image. You can find the ID on the Image Management page. OS images and custom images are supported.	m-gx2x1dhsmusr2****
PolicyGroupId	string	No	The ID of the global policy.	pg-gx2x1dhsmthe9****
DefaultLanguage	string	No	The default language to set when the WUYING Workspace starts. This parameter is valid only when you create a WUYING Workspace from an OS image. Valid values: en-US : English zh-HK : Traditional Chinese (Hong Kong) zh-CN : Simplified Chinese ja-JP : Japanese	zh-CN
TimerGroupId	string	No	The ID of the configuration group.	bcc-dweha*****
ResourceGroupId	string	No	The ID of the resource group.	rg-a5fqjjqaejt***
ResourceTagList	array<object>	No	Tags for the cloud computer, in key-value format. 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 region-specific template configurations. You can specify configurations for multiple regions. The system matches the configuration based on the specific region. Note You can specify configurations for up to 20 regions.
	object	No
RegionId	string	No	The region ID. You can call DescribeRegions to obtain a list of regions that WUYING Workspace supports.	cn-beijing
SnapshotPolicyId	string	No	The ID of the automatic snapshot policy.	sp-35fvn8m2*****
ResourceInstanceType	string	No	The ID of the cloud desktop instance type.	eds.enterprise_office.8c16g
VolumeEncryptionEnable	boolean	No	Specifies whether to enable disk encryption. Valid values: false : Disables disk encryption. [Default] true : Enables disk encryption.	false
VolumeEncryptionKey	string	No	The ID of the KMS key to use when disk encryption is enabled.	a7b3c0c8-b3a2-4876-b1cc-116dddc9****
OfficeSiteId	string	No	The ID of the workspace.	cn-hangzhou+dir-709****
SubnetId	string	No	The ID of the vSwitch.	vsw-adjrehad1****
SiteConfigList	array<object>	No
	object	No
SiteId	string	No
AppRuleId	string	No
ChargeType	string	No
Period	integer	No
PeriodUnit	string	No
AutoPay	boolean	No
AutoRenew	boolean	No
UserDuration	integer	No
PostPaidAfterUsedUp	boolean	No

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.