ModifyTemplate - 修改自定义云电脑模板全部参数

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

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

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
TemplateIdstring

模板 ID。

b-0caoeogs88y*****
TemplateNamestring

模板的名称。必须符合以下要求:

  • 长度 2~126 个英文或中文字符。
  • 必须以大小写字母或中文开头,不能以http://https://开头。
  • 可以包含字母、数字、汉字、半角冒号(:)、下划线(_)或短划线(-),不支持点号(.)。
我的云电脑模板001
Descriptionstring

模板的描述。必须符合以下要求:

  • 长度 2~256 个字符,不能以http://https://开头。
  • 支持中文、英文、数字、空格和特殊符号,使用回车换行。
testDescription
SystemDiskSizeinteger

系统盘大小。单位:GiB。取值范围: 40~500,每 10GiB 为一个步长。

说明 系统盘大小不能小于配置的镜像大小。
80
SystemDiskPerformanceLevelstring

系统盘类型。

说明 只有高主频和图形型的云电脑规格支持 ESSD 类型的磁盘。
枚举值:
  • PL1ESSD极速云盘PL1等级
  • PL0ESSD极速云盘PL0等级
  • AutoPLSSD极速云盘
AutoPL
DataDiskListarray<object>
object
Sizeinteger

数据盘大小。单位:GiB。输入值范围: 40~2040GiB,每 10GiB 为一个步长。

40
PerformanceLevelstring

数据盘性能等级,默认为AutoPL

枚举值:
  • PL1ESSD极速云盘PL1等级
  • PL0ESSD极速云盘PL0等级
  • AutoPLSSD极速云盘
ImageIdstring

云电脑镜像 ID,可以从镜像管理页面查询,支持系统镜像、自定义镜像等类型。

m-gx2x1dhsmusr2****
PolicyGroupIdstring

全局类型的策略 ID。

pg-gx2x1dhsmthe9****
DefaultLanguagestring

云电脑启动时设置的默认语言,仅在使用系统镜像创建云电脑的场景下生效。

枚举值:
  • en-US英语
  • zh-HK繁体中文(香港)
  • zh-CN简体中文
  • ja-JP日语
zh-CN
TimerGroupIdstring

配置组 ID。

bcc-dweha*****
ResourceGroupIdstring

资源组 ID。

rg-a5fqjjqaejt***
ResourceTagListarray<object>

云电脑标签。Key-Value 格式。最多可传入 20 个标签。

object
Keystring

标签键。

department
Valuestring

标签值。

design
RegionConfigListarray<object>

地域化的模板信息配置, 支持配置多个。 使用时会根据具体的地域匹配。

说明 最多支持 20 个地域的配置。
object
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-beijing
SnapshotPolicyIdstring

自动快照策略 ID。

sp-35fvn8m2*****
ResourceInstanceTypestring

云电脑规格 ID。

eds.enterprise_office.8c16g
VolumeEncryptionEnableboolean

是否开启磁盘加密功能。

枚举值:
  • false不开启 [默认值]
  • true开启
false
VolumeEncryptionKeystring

开启磁盘加密的情况下使用的 KMS 的密钥 ID。

a7b3c0c8-b3a2-4876-b1cc-116dddc9****
OfficeSiteIdstring

办公网络 ID。

cn-hangzhou+dir-709****
SubnetIdstring

子网 ID。

vsw-adjrehad1****

返回参数

名称类型描述示例值
object

BaseResult

Successboolean

操作是否成功。取值:true:成功。false:失败。

true
Codestring

执行结果。返回success表示成功,否则将返回错误信息。

success
Messagestring

错误信息。当 Code 为success时,不返回该参数。

success
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

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

错误码

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