使用CreateDesktopGroup API创建共享型云电脑-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

创建共享型云电脑。

接口说明

关于共享型云电脑的功能和应用场景、使用限制、伸缩策略等信息，请参见共享型云电脑（原云电脑池）概述。
调用本接口之前，请确保已创建办公网络、云电脑模板、策略等必需的前置资源。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:CreateDesktopGroup

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
BundleId	string	否	云电脑模板 ID。	b-je9hani001wfn****
OfficeSiteId	string	是	共享型云电脑所属的办公网络 ID。	cn-hangzhou+os-c5cy7q578s8jc****
PolicyGroupId	string	是	共享型云电脑关联的策略 ID。	pg-9c2d6t2dwflqr****
DesktopGroupName	string	否	共享型云电脑名称。不超过 30 个字符。必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。	SharedComputers01
DirectoryId	string	否	目录 ID。说明该参数暂未开放使用。	dri-uf62w3qzt4aigvlcb****
ScaleStrategyId	string	否	伸缩策略 ID。说明该参数暂未开放使用。	ss-f9dkjz6vw3aaw****
VpcId	string	否	共享型云电脑的办公网络所在的 VPC ID。说明该参数暂未开放使用。	vpc-uf6w8u60n8xbkg5el****
DefaultInitDesktopCount	integer	否	创建多台共享型云电脑时默认创建的云电脑数量。默认值为 1。	1
KeepDuration	integer	否	会话断开连接后继续保留的时间。单位为毫秒，取值范围为 180000（3 分钟）~345600000（4 天）。取值为 0 时，表示始终保留。当会话因为用户主动断开或因为其他因素意外断开时，从断开的时刻开始计算，若在该保留时长内用户始终未重新建立与该会话的连接，则该会话注销，未保存的数据都将销毁；若在该保留时长内，用户重新建立连接成功，则仍可进入原来的会话，仍可访问对话断开之前的数据。	180000
ChargeType	string	是	云电脑的付费类型。枚举值： PostPaid : 按量付费 PrePaid : 包年包月	PrePaid
Period	integer	否	包年包月共享型云电脑的购买时长。当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。单位由`PeriodUnit`指定。如果`PeriodUnit`为`Month`，该参数的取值范围： 1 2 3 6 如果`PeriodUnit`为`Year`，该参数的取值范围： 1 2 3 4 5	1
PeriodUnit	string	否	包年包月计费方式的时长单位。枚举值： Month : 月 Year : 年	Month
OwnType	integer	否	共享型云电脑类型。说明该参数暂未开放使用。枚举值： 0 : 个人型（单会话） 1 : 共享型（多会话）	0
AutoPay	boolean	否	是否自动支付包年包月订单。	true
Comments	string	否	备注信息。	comment
MinDesktopsCount	integer	否	包年包月的多台共享型云电脑的自动创建数量上限。即当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。默认值为 1，取值范围为 0~`MaxDesktopsCount`。	1
MaxDesktopsCount	integer	否	按量付费的多台共享型云电脑的最大数量。取值范围：0~500。	50
AllowAutoSetup	integer	否	是否允许包年包月的多台共享型云电脑内自动创建云电脑。即当参数`ChargeType`取值为`PrePaid`时才生效，且为必选值。枚举值： 0 : 不允许 1 : 允许	1
AllowBufferCount	integer	否	按量付费的多台共享型云电脑内允许预留的云电脑数量。当参数`ChargeType`取值为`PostPaid`时才生效，且为必选值。取值范围： 0：不预留 N：预留 N 台（1≤N≤100）说明如果不预留可用云电脑，当终端用户发起连接请求时，系统需要先创建并启动云电脑，然后分配给用户，所需时间相对较长。建议您根据需要预留一定数量的云电脑，保证终端用户的使用体验。	1
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000
EndUserIds	array	否	共享型云电脑的用户 ID 列表。
	string	否	共享型云电脑的用户 ID。	alice
ResetType	integer	否	云电脑重置类型。枚举值： 0 : 不重置 1 : 只重置系统盘 2 : 只重置用户磁盘 3 : 重置系统盘和用户磁盘	0
LoadPolicy	integer	否	多会话共享型云电脑的负载均衡策略。说明该参数暂未开放使用。枚举值： 0 : 深度优先 1 : 广度优先	0
BindAmount	integer	否	多会话共享型云电脑中每台云电脑允许的并发会话数。说明该参数暂未开放使用。	2
Classify	string	否	共享型云电脑的类型。说明该参数暂未开放使用。枚举值： teacher : 教师共享型云电脑 student : 学生共享型云电脑	teacher
AllClassifyUsers	boolean	否	所有共享型云电脑分类的用户。说明该参数暂未开放使用。	Alice
VolumeEncryptionEnabled	boolean	否	是否开启磁盘加密。	false
VolumeEncryptionKey	string	否	开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
RatioThreshold	number	否	会话占用率阈值，用作多会话共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为： `会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%` 当会话占用率达到该阈值时，则会新建云电脑；未达到该阈值时，则删除多余的云电脑。说明该参数暂未开放使用。	0.5
ConnectDuration	integer	否	会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位：毫秒。取值范围：900000（15 分钟）~345600000（4 天）。	900000
IdleDisconnectDuration	integer	否	用户会话建立连接后，如果在该最大时长内，始终没有任何键盘或鼠标操作，则该会话断开连接。单位：毫秒。取值范围为 360000（6 分钟）~3600000（60 分钟）。在达到该时长的 30 秒前，会话中的终端用户将收到保存文档数据的提示消息，此时终端用户需及时保存文档数据，避免丢失。说明仅适用于镜像版本号不低于 1.0.2 的云电脑。	360000
StopDuration	integer	否	空闲关机时间。当云电脑空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。	300000
ProfileFollowSwitch	boolean	否	是否开启用户数据漫游。说明该参数暂未开放使用。	false
FileSystemId	string	否	用户数据漫游功能使用的 NAS 文件系统 ID。说明该参数暂未开放使用。	kegd-nas-****
BuyDesktopsCount	integer	否	对于包年包月多台共享型云电脑：初始创建云电脑的数量。取值范围：0~200。对于按量付费多台共享型云电脑：初始创建云电脑的最小数量。默认值为 1，取值范围为 0~`MaxDesktopsCount`。	3
GroupVersion	integer	否	共享型云电脑版本。	2
AutoRenew	boolean	否	是否为包年包月共享型云电脑开启自动续费。枚举值： true : 开启自动续费 false : 不开启自动续费	false
Tag	array<object>	否	标签列表，最多包含 20 个子项。
	object	否	标签。
Key	string	是	标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	TestKey
Value	string	是	标签值。可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue
PromotionId	string	否	优惠券 ID。	youhuiquan_promotion_option_id_*****
ImageId	string	否	镜像 ID。	m-gx2x1dhsmusr2****
SystemDiskCategory	string	否	系统盘类型。枚举值： cloud_auto : SSD 极速云盘 cloud_essd : ESSD 云盘	cloud_auto
SystemDiskSize	integer	否	系统盘大小，单位：GiB。说明系统盘大小不能小于镜像文件。	80
SystemDiskPerLevel	string	否	ESSD 磁盘性能等级，默认为 PL0。枚举值： PL1 : PL1 PL0 : PL0	PL0
DataDiskCategory	string	否	数据盘类型。枚举值： cloud_auto : SSD 极速云盘 cloud_essd : ESSD 云盘	cloud_auto
DataDiskSize	integer	否	挂载的数据盘容量大小。单位：GB。取值范围：0~16380，取值必须是 20 的整数倍。取值为 0 时，表示不挂载数据盘。如果您选择的套餐使用的是 ESSD 云盘（性能级别 PL0），则挂载的数据盘容量最小值为 40 GB。如果您选择的套餐使用的是 SSD 云盘，则挂载的数据盘容量最小值为 20 GB。默认值：0	80
DataDiskPerLevel	string	否	ESSD 磁盘性能等级，默认为 PL0。枚举值： PL1 : PL1 PL0 : PL0	PL0
DefaultLanguage	string	否	系统语言。枚举值： en-US : 英语 zh-HK : 繁体中文 zh-CN : 简体中文 ja-JP : 日语	zh-CN
DesktopType	string	否	云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。	eds.enterprise_office.16c64g
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
MultiResource	boolean	否	是否为多台共享类型的共享型云电脑。枚举值： true : 多台共享型云电脑 false : 单台共享型云电脑	false
ExclusiveType	string	否	创建静态池。当参数`SessionType`的值为`MultipleSession`时，必须传入此参数，值固定填写为`Exclusive`。	Exclusive
GroupAmount	integer	否	创建单台共享型云电脑的数量。只有当`MultiResource`参数的值为`false`时才需要传入该参数。取值范围：1~5。默认值：1。	1
SessionType	string	否	会话类型。枚举值： SingleSession : 单会话 MultipleSession : 多会话	SingleSession
TimerGroupId	string	否	定时任务组 ID。	ccg-0caoeogrk9m5****
SnapshotPolicyId	string	否	自动快照策略 ID。	sp-28mp6my0l6zow****
ResellerOwnerUid	integer	否
UserOuPath	string	否
UserGroupName	string	否
SimpleUserGroupId	string	否
DeleteDuration	integer	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
DesktopGroupId	string	共享型云电脑 ID。	dg-2i8qxpv6t1a03****
RequestId	string	请求 ID。	3EB7FCEE-D731-4948-85A3-4B2C341CA983
OrderIds	array	订单 ID。
	string	订单 ID。当请求参数`ChargeType`取值为`PrePaid`时，返回该参数。	123456789
DesktopGroupIds	array	共享型云电脑 ID 列表。
	string	共享型云电脑 ID 列表。	['dg-1np2yupx0uim****']

示例

正常返回示例

JSON格式

{
  "DesktopGroupId": "dg-2i8qxpv6t1a03****",
  "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
  "OrderIds": [
    "123456789"
  ],
  "DesktopGroupIds": [
    "['dg-1np2yupx0uim****']"
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。