调用CreateDesktops创建一台或多台云桌面_无影云电脑企业版(EDS)-阿里云帮助中心

创建一台或多台云电脑。创建时若传入用户信息，可直接完成云电脑的分配。

接口说明

创建云电脑前，请先完成以下准备工作：

已创建办公网络（原工作区）和用户。相关接口或文档请参见：
- 便捷办公网络： CreateSimpleOfficeSite 、 CreateUsers 。
- AD 办公网络： CreateADConnectorOfficeSite 、创建 AD 用户。
已调用 CreateBundle 创建云电脑模板，或确认使用已有云电脑模板。
已调用 CreatePolicyGroup 创建策略，或确认使用已有策略。

如需让云电脑自动执行自定义命令脚本，可使用UserCommands字段配置自定义命令。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
GroupId	string	否	云电脑池 ID。	dg-boyczi8enfyc5****
BundleId	string	是	云电脑模板 ID。	b-je9hani001wfn****
DesktopName	string	否	云电脑名称。命名规则如下：不超过 64 个字符。必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。	DemoComputer01
UserName	string	否	说明此参数不开放使用。	username
VpcId	string	否	说明此参数不开放使用。	vpc-uf6w8u60n8xbkg5el****
Amount	integer	否	创建的云电脑数量。取值范围为 1~300，默认值为 1。	1
DirectoryId	string	否	说明此参数不开放使用。	cn-hangzhou+dir-300943****
OfficeSiteId	string	是	办公网络 ID。	cn-hangzhou+dir-387822****
PolicyGroupId	string	是	策略 ID。	system-all-enabled-policy
ChargeType	string	否	云电脑的计费方式。枚举值： PostPaid：按量付费 [默认值]。 PrePaid：包年包月。	PrePaid
Period	integer	否	购买资源的时长。单位由`PeriodUnit`指定。当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。如果`PeriodUnit`为`Month`，该参数的取值范围： 1 2 3 6 如果`PeriodUnit`为`Year`，该参数的取值范围： 1 2 3 4 5	1
PeriodUnit	string	否	包年包月计费方式的时长单位。枚举值： Month：月 [默认值]。 Year：年。	Month
AutoPay	boolean	否	是否自动支付。枚举值： true：自动支付。请确保账户余额充足，否则会产生异常订单 [默认值]。 false：只产生订单，不支付。您可以登录控制台，在用户中心的我的订单页面，根据返回的订单号进行支付。	false
AutoRenew	boolean	否	是否自动续费。当参数`ChargeType`取值为`PrePaid`时才生效。枚举值： true：自动续费。续费时长与购买设置的时长保持一致。 false：不自动续费 [默认值]。	false
PromotionId	string	否	优惠活动 ID。	23141
UserAssignMode	string	否	云电脑分配模式。说明如果未设置`EndUserId`，创建的云电脑不会分配给用户。枚举值： ALL：如果设置了EndUserId，则将创建的云电脑分配给每个指定的用户 [默认值]。 PER_USER：如果设置了EndUserId，则将创建的云电脑平均分配给指定的用户。此时需确保Amount的值可以被EndUserId的个数（即N）整除。	ALL
Hostname	string	否	自定义设置云电脑的主机名称。仅支持设置 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`为起始数字，取值支持 0~999999，默认值为 0；`bits`为数字位数，取值支持 1~6，默认值为 6。 `name_suffix`：主机名称的后缀。	testhost
EndUserId	array	否	为云电脑添加的授权用户 ID 列表。可设置 1~100 个。
	string	否	为云电脑添加的授权用户 ID。在同一时段内，只有一个用户可以使用该云电脑。如果未设置`EndUserId`，创建的云电脑不会分配给任何用户。	alice
Tag	array<object>	否	标签。
	object	否	标签。
Key	string	否	标签键。可设置 1~20 个。	TestKey
Value	string	否	标签值。可设置 1~20 个。	TestValue
DesktopNameSuffix	boolean	否	批量创建云电脑时，云电脑名称是否自动增加后缀。枚举值： true：自动增加后缀 [默认值]。 false：不增加后缀。	false
VolumeEncryptionEnabled	boolean	否	是否开启磁盘加密。枚举值： true：开启磁盘加密。 false：不开启磁盘加密 [默认值]。	false
VolumeEncryptionKey	string	否	开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DesktopMemberIp	string	否	指定云电脑私网 IP。	10.0.0.1
UserCommands	array<object>	否	用户自定义命令脚本数据。
	object	否	用户自定义命令脚本数据。
ContentEncoding	string	否	命令内容（CommandContent）的编码方式。枚举值： Base64：Base64编码。 PlainText：不编码，采用明文传输。	Base64
Content	string	否	命令内容。	bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****
ContentType	string	否	命令的语言类型。枚举值： RunPowerShellScript：适用于Windows实例的PowerShell命令。 RunShellScript：适用于Linux实例Shell命令。 RunBatScript：适用于Windows实例的Bat命令。	RunPowerShellScript
BundleModels	array<object>	否	云电脑模板列表。
	object	否	云电脑模板。
BundleId	string	否	云电脑模板 ID。	b-je9hani001wfn****
Amount	integer	否	创建的云电脑数量。取值范围为 1~300，默认值为 0。	1
EndUserIds	array	否	云电脑分配用户列表。
	string	否	用户名称。	alice
DesktopName	string	否	云电脑名称。命名规则如下：不超过 64 个字符。必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。	DemoComputer02
Hostname	string	否	自定义设置云电脑的主机名称。仅支持设置 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`为起始数字，取值支持 0~999999，默认值为 0；`bits`为数字位数，取值支持 1~6，默认值为 6。 `name_suffix`：主机名称的后缀。	testhost
VolumeEncryptionEnabled	boolean	否	是否开启磁盘加密。	false
VolumeEncryptionKey	string	否	开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DesktopTimers	array<object>	否	云电脑定时任务详情。
	object	否	云电脑定时任务详情。
TimerType	string	否	定时任务类型。	NoOperationReboot
CronExpression	string	否	定时任务 Cron 表达式。注意需要传入 UTC 标准时间，即北京时间每天 0 点应该传入 0 0 16 ? * 1,2,3,4,5,6,7	0 40 7 ? * 1,2,3,4,5,6,7
Interval	integer	否	时间间隔，单位为分钟。	10
Enforce	boolean	否	是否强制执行。枚举值： true：忽略云电脑及连接状态检测，强制执行定时任务。 false：不强制执行。	true
ResetType	string	否	云电脑重置类型。枚举值： RESET_TYPE_SYSTEM：重置系统盘。 RESET_TYPE_BOTH：重置系统盘和用户磁盘。	RESET_TYPE_SYSTEM
OperationType	string	否	定时任务操作类型，目前仅断连定时任务支持。枚举值： Hibernate：休眠。 Shutdown：关机。	Shutdown
AllowClientSetting	boolean	否	是否允许终端用户自行配置定时任务。	true
MonthDesktopSetting	object	否	说明此字段暂不对外开放使用。
UseDuration	integer	否	说明此字段暂不对外开放使用。	null
BuyerId	long	否	说明此字段暂不对外开放使用。	null
DesktopId	string	否	说明此字段暂不对外开放使用。	null
SnapshotPolicyId	string	否	无影自动快照策略 ID。	sp-28mp6my0l6zow****
ResourceGroupId	string	否	无影资源组 ID。	rg-3mtuc28rx95lx****

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
OrderId	string	订单 ID。说明当请求参数 ChargeType 取值为 PrePaid 时，返回该参数。	123456789
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopId	array	云电脑 ID 返回集合信息，如果一次调用创建了多个云电脑，将返回多个云电脑 ID。
DesktopIds	string	云电脑 ID。	["ecd-gx2x1dhsmucyy****"]

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidEncryptionKey.Missing	Parameter VolumeEncryptionKey is missing.	开启磁盘加密功能时，加密密钥不可为空
400	InvalidEncryptionKey.NotAuthorized	Eds service cannot access the given VolumeEncryptionKey.	无法访问未经授权的加密密钥
400	InvalidEncryptionKey.NotFound	The specified VolumeEncryptionKey is not found.	找不到指定的磁盘加密密钥
400	InvalidImageStatus.NotValid	The specified image status is not valid.	指定镜像的状态不可用，不支持创建桌面
400	InvalidImageVersion.NotSupported	The specified image version is no longer supported.	指定的镜像版本已不再支持，请选择其他镜像
400	InvalidMemberIp.DesktopAmount	The desktop amount need to be 1.	指定IP创建桌面时，桌面数量仅可为1
400	InvalidPolicyGroup.Status	The target policy group is being created. Please try again later.	目标策略组正在创建中，请稍后再试。
400	Protocol.NotAllowed	Procotol of the image is not allowed.	不支持该镜像的协议类型，请检查镜像ID
400	ExistedHostname	The specified hostname is existed on the domain.	指定的主机名在当前工作区已存在
400	HostnameCannotCustomizeForLinux	Customizing hostname is not supported for Linux desktop.	自定义主机名功能不支持Linux桌面
400	IncorrectDirectoryStatus	Only registered directory can create desktop.	工作区状态错误，仅支持使用已注册的工作区创建桌面
400	IncorrectDirectoryType	The protocol type of directory and desktop do not match.	指定工作区和目标桌面的协议类型不匹配，请检查
400	InvalidAmount	The specified Amount is not a valid value.	指定的数量不合法
400	InvalidAmount.NotTimesOfUsers	The specified Amount is notmatch EndUserId size.	指定的桌面数量不等于待分配用户的数量，请重新指定
400	InvalidDesktopBundle.NotFound	The specified param BundleId is not found.	指定的BundleId找不到
400	InvalidDirectoryId.NotFound	The specified param DirectoryId is not found.	无法找到工作区ID，请检查工作区ID是否正确
400	InvalidDirectoryType.NotSupported	The specified DirectoryType is not supported.	指定的工作区类型不支持创建该桌面
400	InvalidEncryptionEnabled.Invalid	The parameter VolumeEncryptionEnabled is invalid.	指定加密密钥时，需开启磁盘加密功能

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

变更历史

变更时间	变更内容概要	操作
2024-09-27	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-07-31	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-07-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-04-29	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-11-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-11-15	OpenAPI 错误码发生变更	查看变更详情
2023-11-15	OpenAPI 错误码发生变更	查看变更详情
2023-05-24	OpenAPI 入参发生变更	查看变更详情
2023-05-24	OpenAPI 入参发生变更	查看变更详情
2023-04-24	OpenAPI 入参发生变更	查看变更详情
2023-03-14	OpenAPI 入参发生变更	查看变更详情
2022-08-08	OpenAPI 入参发生变更	查看变更详情