首页 无影云桌面 API参考(云桌面管控) API目录 桌面 CreateDesktops - 创建一台或多台云桌面

CreateDesktops - 创建一台或多台云桌面

为用户创建一台或多台云桌面。

接口说明

1、创建云桌面前,请先完成以下准备工作:

2、新建桌面后自动执行自定义命令脚本。

  • UserCommands字段可配置自定义命令。

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
GroupIdstring

桌面组ID。

说明桌面组功能目前处于邀测中,如需体验,请提交工单申请。
dg-boyczi8enfyc5****
BundleIdstring

桌面模板ID。

b-je9hani001wfn****
DesktopNamestring

云桌面名称。命名规则如下:

  • 不超过 64 个字符。
  • 必须以大小字母或中文开头,不能以 http:// 和 https:// 开头。
  • 可以包含中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)。
testDesktopName
UserNamestring

此参数不开放使用。

To be hidden.
VpcIdstring

此参数不开放使用。

To be hidden.
Amountinteger

创建的云桌面数量。取值范围为1~300,默认值为1。

1
DirectoryIdstring

此参数不开放使用。

To be hidden.
OfficeSiteIdstring

工作区ID。

cn-hangzhou+os-c5cy7q578s8jc****
PolicyGroupIdstring

策略ID。

system-all-enabled-policy
ChargeTypestring

云桌面的计费方式。

PrePaid
枚举值:
- PostPaid: 按量付费 [默认值]
- PrePaid: 包年包月
Periodinteger

购买资源的时长。单位由PeriodUnit指定。当参数ChargeType取值为PrePaid时才生效,且为必选值。

  • 如果PeriodUnitMonth,该参数的取值范围:

    • 1
    • 2
    • 3
    • 6
  • 如果PeriodUnitYear,该参数的取值范围:

    • 1
    • 2
    • 3
    • 4
    • 5
1
PeriodUnitstring

包年包月计费方式的时长单位。

Month
枚举值:
- Month: 月 [默认值]
- Year:
AutoPayboolean

是否自动支付。

false
枚举值:
- true: 自动支付。请确保账户余额充足,否则会产生异常订单。 [默认值]
- false: 只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。
AutoRenewboolean

是否自动续费。当参数ChargeType取值为PrePaid时才生效。

false
枚举值:
- true: 自动续费。续费时长与购买设置的时长保持一致。
- false: 不自动续费。[默认值]
PromotionIdstring

优惠活动ID。

23141
UserAssignModestring

桌面分配模式。

说明如果未设置EndUserId,创建的云桌面不会分配给用户。
ALL
枚举值:
- ALL: 如果设置了EndUserId,则将创建的云桌面分配给每个指定的用户。 [默认值]
- PER_USER: 如果设置了EndUserId,则将创建的云桌面平均分配给指定的用户。此时需确保Amount的值可以被EndUserId的个数(即N)整除。
Hostnamestring

自定义设置云桌面的主机名称。仅支持设置AD工作区下,操作系统类型是Windows的云桌面。

主机名称的命名规则如下:

  • 长度为2~15个字符。
  • 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。

创建多台云桌面时,可以使用name_prefix[begin_number,bits]name_suffix的命名格式为多台云桌面统一命名。例如,设置Hostname的取值为ecd-[1,4]-test,则第一台云桌面主机名称为ecd-0001-test,第二台云桌面主机名称为ecd-0002-test,依次类推。

  • name_prefix:主机名称的前缀。
  • [begin_number,bits]:主机名称中的有序数字。begin_number为起始数字,取值支持0999999,默认值为0;bits为数字位数,取值支持16,默认值为6。
  • name_suffix:主机名称的后缀。
testhost
EndUserIdarray

授权使用云桌面的用户ID,即将桌面分配给用户。可设置1~100个。

  • 在同一时段内,只有一个用户可以使用该桌面。
  • 如果未设置EndUserId,创建的云桌面不会分配给任何用户。
string

授权使用云桌面的用户ID,即将桌面分配给用户。

  • 在同一时段内,只有一个用户可以使用该桌面。
  • 如果未设置EndUserId,创建的云桌面不会分配给任何用户。
test1
Tagarray

标签。

object

标签。

Keystring

标签键。可设置1~20个。

TestKey
Valuestring

标签值。可设置1~20个。

TestValue
DesktopNameSuffixboolean

批量创建桌面时,桌面名称是否自动增加后缀。

false
枚举值:
- true: 自动增加后缀。[默认值]
- false: 不增加后缀。
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
枚举值:
- true: 开启磁盘加密。
- false: 不开启磁盘加密。[默认值]
VolumeEncryptionKeystring

开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
UserCommandsarray

用户自定义命令脚本数据。

object

用户自定义命令脚本数据。

ContentEncodingstring

命令内容(CommandContent)的编码方式。

Base64
枚举值:
- Base64: Base64编码
- PlainText: 不编码,采用明文传输
Contentstring

命令内容。

bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****
ContentTypestring

运维命令的语言类型。

RunPowerShellScript
枚举值:
- RunPowerShellScript: 适用于Windows实例的PowerShell命令
- RunShellScript: 适用于Linux实例Shell命令
- RunBatScript: 适用于Windows实例的Bat命令
BundleModelsarray
object
BundleIdstring
Amountinteger
EndUserIdsarray
string
DesktopNamestring
Hostnamestring
VolumeEncryptionEnabledboolean
VolumeEncryptionKeystring

返回参数

名称类型描述示例值
object

返回信息集合。

OrderIdstring

订单ID。

说明当请求参数ChargeType取值为PrePaid时,返回该参数。
123456789
RequestIdstring

请求ID。

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

云桌面ID返回集合信息,如果一次调用创建了多个云桌面,将返回多个云桌面ID。

string

云桌面ID。

["ecd-gx2x1dhsmucyy****"]

示例

正常返回示例

JSON格式

{
  "OrderId": "123456789",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DesktopId": [
    "[\"ecd-gx2x1dhsmucyy****\"]"
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-08OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:UserCommands
2022-08-04 OpenAPI CreateDesktops 已下线
变更项变更内容
阿里云首页 无影云桌面 相关技术圈