调用ModifyTemplate全量更新云电脑模板-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

修改自定义云电脑模板的全部参数。

接口说明

警告为了兼容模板中参数的不设置与默认升级逻辑，该接口采用全量参数更新逻辑，换言之，不设置的参数均视为设置为空。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ModifyTemplate

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TemplateId	string	是	模板 ID。	b-0caoeogs88y*****
TemplateName	string	否	模板的名称。必须符合以下要求：长度 2~126 个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`和`https://`开头。可以包含字母、数字、汉字、半角冒号（:）、下划线（_）或短划线（-），不支持点号（.）。	我的云电脑模板001
Description	string	否	模板的描述。必须符合以下要求：长度 2~256 个字符，不能以`http://`和`https://`开头。支持中文、英文、数字、空格和特殊符号，使用回车换行。	testDescription
SystemDiskSize	integer	否	系统盘大小。单位：GiB。取值范围: 40~500，每 10GiB 为一个步长。说明系统盘大小不能小于配置的镜像大小。	80
SystemDiskPerformanceLevel	string	否	系统盘类型。说明只有高主频和图形型的云电脑规格支持 ESSD 类型的磁盘。枚举值： PL1 : ESSD 极速云盘 PL1 等级 PL0 : ESSD 极速云盘 PL0 等级 AutoPL : SSD 极速云盘	AutoPL
DataDiskList	array<object>	否	系统盘性能等级
	object	否
Size	integer	否	数据盘大小。单位：GiB。输入值范围: 40~2040GiB，每 10GiB 为一个步长。	40
PerformanceLevel	string	否	数据盘性能等级，默认为`AutoPL`。枚举值： PL1 : ESSD 极速云盘 PL1 等级 PL0 : ESSD 极速云盘 PL0 等级 AutoPL : SSD 极速云盘	AutoPL
ImageId	string	否	云电脑镜像 ID，可以从镜像管理页面查询，支持系统镜像、自定义镜像等类型。	m-gx2x1dhsmusr2****
PolicyGroupId	string	否	全局类型的策略 ID。	pg-gx2x1dhsmthe9****
DefaultLanguage	string	否	云电脑启动时设置的默认语言，仅在使用系统镜像创建云电脑的场景下生效。枚举值： en-US : 英语 zh-HK : 繁体中文（香港） zh-CN : 简体中文 ja-JP : 日语	zh-CN
TimerGroupId	string	否	配置组 ID。	bcc-dweha*****
ResourceGroupId	string	否	资源组 ID。	rg-a5fqjjqaejt***
ResourceTagList	array<object>	否	云电脑标签。Key-Value 格式。最多可传入 20 个标签。
	object	否
Key	string	否	标签键。	department
Value	string	否	标签值。	design
RegionConfigList	array<object>	否	地域化的模板信息配置，支持配置多个。使用时会根据具体的地域匹配。说明最多支持 20 个地域的配置。
	object	否
RegionId	string	否	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-beijing
SnapshotPolicyId	string	否	自动快照策略 ID。	sp-35fvn8m2*****
ResourceInstanceType	string	否	云电脑规格 ID。	eds.enterprise_office.8c16g
VolumeEncryptionEnable	boolean	否	是否开启磁盘加密功能。枚举值： false : 不开启 [默认值] true : 开启	false
VolumeEncryptionKey	string	否	开启磁盘加密的情况下使用的 KMS 的密钥 ID。	a7b3c0c8-b3a2-4876-b1cc-116dddc9****
OfficeSiteId	string	否	办公网络 ID。	cn-hangzhou+dir-709****
SubnetId	string	否	子网 ID。	vsw-adjrehad1****
SiteConfigList	array<object>	否	区域配置管理
	object	否
SiteId	string	否	站点名称。	mainland
AppRuleId	string	否	应用管控策略 ID	bwr-5a5371e0*******
ChargeType	string	否	云电脑的付费类型。枚举值： PostPaid : 按量付费 PrePaid : 包年包月	PrePaid
Period	integer	否	包年包月共享型云电脑的购买时长。当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。单位由`PeriodUnit`指定。如果`PeriodUnit`为`Month`，该参数的取值范围： 1 2 3 6 如果`PeriodUnit`为`Year`，该参数的取值范围： 1 2 3 4 5	1
PeriodUnit	string	否	包年包月计费方式的时长单位。枚举值： Month : 月 Year : 年 Week : 周	Month
AutoPay	boolean	否	是否自动支付包年包月订单。
AutoRenew	boolean	否	是否为包年包月共享型云电脑开启自动续费。
UserDuration	integer	否	单用户使用时长套餐。枚举值： 120 : 120 小时 250 : 250 小时 360 : 360 小时	120
PostPaidAfterUsedUp	boolean	否	时长包用尽后是否自动转为按量付费继续使用。

返回参数

名称	类型	描述	示例值
	object	BaseResult
Success	boolean	操作是否成功。取值：true：成功。false：失败。	true
Code	string	执行结果。返回`success`表示成功，否则将返回错误信息。	success
Message	string	错误信息。当 Code 为`success`时，不返回该参数。	success
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。