CreateDesktops_无影云电脑_API调试-阿里云OpenAPI开发者门户

接口说明

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

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

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

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。示例值:cn-hangzhou
GroupIdstring	云电脑池 ID。示例值:dg-boyczi8enfyc5****参考取值来源: BindConfigGroup ModifyTimerGroup UnbindConfigGroup ClonePolicyGroup AddUserToDesktopGroup CreateConfigGroup
BundleIdstring	云电脑模板 ID。示例值:b-je9hani001wfn****参考取值来源: CreateBundle DescribeBundles
DesktopNamestring	云电脑名称。命名规则如下：展开详情示例值:DemoComputer01参考取值来源: DescribeDesktops
UserNamestring	说明此参数不开放使用。示例值:username
VpcIdstring	说明此参数不开放使用。示例值:vpc-uf6w8u60n8xbkg5el****
Amountinteger<int32>	创建的云电脑数量。取值范围为 1~300，默认值为 1。示例值:1取值 <= 500
DirectoryIdstring	说明此参数不开放使用。示例值:cn-hangzhou+dir-300943****参考取值来源: CreateRAMDirectory
OfficeSiteIdstring	办公网络 ID。示例值:cn-hangzhou+dir-387822****参考取值来源: DescribeOfficeSites CreateSimpleOfficeSite ListOfficeSiteOverview
PolicyGroupIdstring	策略 ID。示例值:system-all-enabled-policy参考取值来源: ClonePolicyGroup CreatePolicyGroup DescribePolicyGroups GetDesktopGroupDetail
ChargeTypestring	云电脑的计费方式。示例值:PrePaid枚举值:PostPaidPrePaid
Periodinteger<int32>	购买资源的时长。单位由`PeriodUnit`指定。当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。展开详情示例值:1
PeriodUnitstring	包年包月计费方式的时长单位。示例值:Month枚举值:MonthYear
AutoPayboolean	是否自动支付。示例值:false枚举值:truefalse
AutoRenewboolean	是否自动续费。当参数`ChargeType`取值为`PrePaid`时才生效。示例值:false枚举值:truefalse
PromotionIdstring	优惠活动 ID。示例值:23141
UserAssignModestring	云电脑分配模式。展开详情示例值:ALL枚举值:ALLPER_USER
Hostnamestring	自定义设置云电脑的主机名称。仅支持设置 AD 办公网络下，操作系统类型是 Windows 的云电脑。展开详情示例值:testhost
EndUserIdarray<string>	为云电脑添加的授权用户 ID 列表。可设置 1~100 个。示例值:123456789子级条数 <= 100
Tagarray<object>	标签。子级条数 <= 20
DesktopNameSuffixboolean	批量创建云电脑时，云电脑名称是否自动增加后缀。示例值:false枚举值:truefalse
VolumeEncryptionEnabledboolean	是否开启磁盘加密。示例值:false枚举值:truefalse
VolumeEncryptionKeystring	开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。示例值:08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DesktopMemberIpstring	指定云电脑私网 IP。示例值:10.0.0.1
UserCommandsarray<object>	用户自定义命令脚本数据。子级条数 <= 20
BundleModelsarray<object>	云电脑模板列表。子级条数 <= 20
DesktopTimersarray<object>	云电脑定时任务详情。子级条数 <= 20
MonthDesktopSettingobject	说明此字段暂不对外开放使用。
SnapshotPolicyIdstring	无影自动快照策略 ID。示例值:sp-28mp6my0l6zow****
ResourceGroupIdstring	无影资源组 ID。示例值:rg-3mtuc28rx95lx****参考取值来源: DescribeResourceByCenterPolicyId
DesktopAttachmentobject	无模板方式入参。
TimerGroupIdstring	定时任务组 ID。示例值:ccg-0caoeogrk9m5****
SavingPlanIdstring
ExtendInfostring

返回参数

字段名称	字段详情
OrderIdstring	订单 ID。展开详情示例值:123456789
RequestIdstring	请求 ID。示例值:1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopIdarray<string>	云电脑 ID 返回集合信息，如果一次调用创建了多个云电脑，将返回多个云电脑 ID。

变更历史

	变更时间	变更内容概要	操作
	2025-03-17	新增请求参数ExtendInfo
	2025-02-11	新增请求参数SavingPlanId
	2024-09-27	新增请求参数DesktopAttachment 新增请求参数TimerGroupId
	2024-07-31	新增请求参数ResourceGroupId
	2024-07-22	新增请求参数SnapshotPolicyId

1
2
3
10 条/页