创建一个自定义的云电脑模板。云电脑模板(简称模板)是云电脑配置的合集,用于减少创建云电脑时的配置步骤,加快创建云电脑的速度。
接口说明
调用该接口时,您需要注意:
-
实例启动模板的参数大多数为可选参数。创建模板时,阿里云不会严格验证模板中参数取值的存在性和有效性。只会在真正创建实例时校验参数取值的有效性。
-
对于模板中具有地域属性的参数,若使用该模板创建云电脑时地域不匹配,则这些参数不会生效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:CreateTemplate | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateName | string | 是 | 模板的名称。必须符合以下要求:
| 我的云电脑模板001 |
Description | string | 否 | 模板的描述。必须符合以下要求:
| 设计部模板 |
ProductType | string | 否 | 产品类型。固定填写 枚举值:
| CloudDesktop |
BizType | string | 否 | 说明
该参数暂不对外开放使用。
枚举值:
| 1 |
SystemDiskSize | integer | 否 | 系统盘大小。单位:GiB。取值范围: 40~500,每 10GiB 为一个步长。 说明
系统盘大小不能小于配置的镜像大小。
| 80 |
SystemDiskPerformanceLevel | string | 否 | 系统盘类型。 说明
只有高主频和图形型的云电脑规格支持 ESSD 类型的磁盘。
枚举值:
| AutoPL |
DataDiskList | array<object> | 否 | 数据盘大小和规格配置。 | |
object | 否 | |||
Size | integer | 否 | 系统盘大小。单位:GiB。取值范围: 40~2040,每 10GiB 为一个步长。 注意 ESSD 云盘容量越大,可供选择的“性能级别”越高 (例如 460GiB 以上可选 PL2)。性能级别越高,费用也越高,请根据您的使用需求合理选择 ESSD 云盘性能级别。 | 40 |
PerformanceLevel | string | 否 | 数据盘性能等级,默认为 | AutoPL |
ImageId | string | 否 | 云电脑镜像 ID,可以从镜像管理页面查询, 支持系统镜像、自定义镜像等类型。 | desktopimage-windows-server-2022-64-asp |
DefaultLanguage | string | 否 | 云电脑启动时设置的默认语言,仅在使用系统镜像创建云电脑的场景下生效。 | zh-CN |
PolicyGroupId | string | 否 | 全局类型的策略 ID。 | pg-8hlryfn331****** |
TimerGroupId | string | 否 | 配置组 ID。 | ccg-0caoeogrk9m5**** |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-4knxmfneq1e****** |
ResourceTagList | array<object> | 否 | 云电脑标签。Key-Value 格式。最多可传入 20 个标签。 | |
object | 否 | |||
Key | string | 否 | 标签键。 | department |
Value | string | 否 | 标签值。 | design |
RegionConfigList | array<object> | 否 | 地域化的模板信息配置, 支持配置多个。 使用时会根据具体的地域匹配。 说明
最多支持 20 个地域的配置。
| |
object | 否 | |||
RegionId | string | 否 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
SnapshotPolicyId | string | 否 | 自动快照策略 ID。 | sp-35fvn8m21pnx2**** |
ResourceInstanceType | string | 否 | 云电脑规格 ID。 | eds.enterprise_office.8c16g |
VolumeEncryptionEnable | boolean | 否 | 是否开启磁盘加密功能。 枚举值:
| false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。 | a7b3c0c8-b3a2-4876-b1cc-********* |
OfficeSiteId | string | 否 | 办公网络 ID。 | cn-hangzhou+dir-709****** |
SubnetId | string | 否 | 子网 ID。 | vsw-bp1yiu********** |
SiteConfigList | array<object> | 否 | 区域配置管理 | |
object | 否 | |||
SiteId | string | 否 | 站点 ID。 枚举值:
| mainland |
AppRuleId | string | 否 | 应用管控策略 ID | bwr-5a5371e0db954d******** |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": "b-0cc7rx533*****",
"Success": true,
"Code": "success",
"Message": "success",
"HttpStatusCode": 200,
"RequestId": "791CC0D3-1A38-573B-8F5F-********"
}
错误码
访问错误中心查看更多错误码。