接口说明
- 关于共享型云电脑的功能和应用场景、使用限制、伸缩策略等信息,请参见共享型云电脑(原云电脑池)概述。
- 调用本接口之前,请确保已创建办公网络、云电脑模板、策略等必需的前置资源。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 示例值:cn-hangzhou |
BundleIdstring | 云电脑模板 ID。 示例值:b-je9hani001wfn****参考取值来源: CreateBundle DescribeBundles |
OfficeSiteIdstring | 共享型云电脑所属的办公网络 ID。 示例值:cn-hangzhou+os-c5cy7q578s8jc****参考取值来源: DescribeOfficeSites ListOfficeSiteOverview CreateSimpleOfficeSite |
PolicyGroupIdstring | 共享型云电脑关联的策略 ID。 示例值:pg-9c2d6t2dwflqr****参考取值来源: ClonePolicyGroup CreatePolicyGroup DescribePolicyGroups GetDesktopGroupDetail |
DesktopGroupNamestring | 共享型云电脑名称。不超过 30 个字符。必须以大小字母或中文开头,不能以 示例值:SharedComputers01参考取值来源: GetDesktopGroupDetail DescribeDesktopGroups |
DirectoryIdstring | 目录 ID。展开详情 示例值:dri-uf62w3qzt4aigvlcb****参考取值来源: CreateRAMDirectory |
ScaleStrategyIdstring | 伸缩策略 ID。展开详情 示例值:ss-f9dkjz6vw3aaw**** |
VpcIdstring | 共享型云电脑的办公网络所在的 VPC ID。展开详情 示例值:vpc-uf6w8u60n8xbkg5el**** |
DefaultInitDesktopCountinteger<int32> | 创建多台共享型云电脑时默认创建的云电脑数量。默认值为 1。 示例值:1取值 <= 1000 |
KeepDurationinteger<int64> | 会话断开连接后继续保留的时间。单位为毫秒,取值范围为 180000(3 分钟)~345600000(4 天)。取值为 0 时,表示始终保留。展开详情 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:180000 |
ChargeTypestring | 云电脑的付费类型。 示例值:PrePaid枚举值:PostPaidPrePaid |
Periodinteger<int32> | 包年包月共享型云电脑的购买时长。当参数 示例值:1 |
PeriodUnitstring | 包年包月计费方式的时长单位。 示例值:Month枚举值:MonthYear |
OwnTypeinteger<int32> | 共享型云电脑类型。展开详情 示例值:0枚举值:01 |
AutoPayboolean | 是否自动支付包年包月订单。 示例值:true |
Commentsstring | 备注信息。 示例值:comment |
MinDesktopsCountinteger<int32> | 包年包月的多台共享型云电脑的自动创建数量上限。即当参数 示例值:1取值 <= 500 |
MaxDesktopsCountinteger<int32> | 按量付费的多台共享型云电脑的最大数量。取值范围:0~500。 示例值:50取值 <= 1000 |
AllowAutoSetupinteger<int32> | 是否允许包年包月的多台共享型云电脑内自动创建云电脑。即当参数 示例值:1枚举值:01取值 <= 1 |
AllowBufferCountinteger<int32> | 按量付费的多台共享型云电脑内允许预留的云电脑数量。当参数 示例值:1取值 <= 1000 |
ClientTokenstring | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 示例值:123e4567-e89b-12d3-a456-426655440000 |
EndUserIdsarray<string> | 共享型云电脑的用户 ID 列表。 子级条数 <= 1000 |
ResetTypeinteger<int64> | 云电脑重置类型。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:0枚举值:0123 |
LoadPolicyinteger<int64> | |
BindAmountinteger<int64> | |
Classifystring | 共享型云电脑的类型。展开详情 示例值:teacher枚举值:teacherstudent |
AllClassifyUsersboolean | 所有共享型云电脑分类的用户。展开详情 示例值:Alice |
VolumeEncryptionEnabledboolean | 是否开启磁盘加密。 示例值:false |
VolumeEncryptionKeystring | 开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。 示例值:08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
RatioThresholdnumber<float> | 会话占用率阈值,用作多会话共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:展开详情 示例值:0.5 |
ConnectDurationinteger<int64> | 会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。取值范围:900000(15 分钟)~345600000(4 天)。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:900000参考取值来源: DescribeUserConnectionRecords |
IdleDisconnectDurationinteger<int64> | 用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。取值范围为 360000(6 分钟)~3600000(60 分钟)。展开详情 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:360000 |
StopDurationinteger<int64> | 空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:300000 |
ProfileFollowSwitchboolean | 是否开启用户数据漫游。展开详情 示例值:false |
FileSystemIdstring | 用户数据漫游功能使用的 NAS 文件系统 ID。展开详情 示例值:kegd-nas-****参考取值来源: CreateNASFileSystem DescribeNASFileSystems |
BuyDesktopsCountinteger<int32> |
示例值:3 |
GroupVersioninteger<int32> | 共享型云电脑版本。 示例值:2 |
AutoRenewboolean | 是否为包年包月共享型云电脑开启自动续费。 示例值:false枚举值:truefalse |
Tagarray<object> | 标签列表,最多包含 20 个子项。 子级条数 <= 100 |
PromotionIdstring | 优惠券 ID。 示例值:youhuiquan_promotion_option_id_***** |
ImageIdstring | 镜像 ID。 示例值:m-gx2x1dhsmusr2****参考取值来源: UploadImage CopyImage CreateImage DescribeImages |
SystemDiskCategorystring | 系统盘类型。 示例值:cloud_auto枚举值:cloud_autocloud_essd |
SystemDiskSizeinteger<int32> | 系统盘大小,单位:GiB。展开详情 示例值:80 |
SystemDiskPerLevelstring | ESSD 磁盘性能等级,默认为 PL0。 示例值:PL0枚举值:PL1PL0 |
DataDiskCategorystring | 数据盘类型。 示例值:cloud_auto枚举值:cloud_autocloud_essd |
DataDiskSizeinteger<int32> | 挂载的数据盘容量大小。单位:GB。取值范围:0~16380,取值必须是 20 的整数倍。展开详情 示例值:80 |
DataDiskPerLevelstring | ESSD 磁盘性能等级,默认为 PL0。 示例值:PL0枚举值:PL1PL0 |
DefaultLanguagestring | 系统语言。 示例值:zh-CN枚举值:en-USzh-HKzh-CNja-JP |
DesktopTypestring | 云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。 示例值:eds.enterprise_office.16c64g参考取值来源: DescribeDesktopTypes |
Hostnamestring | 自定义设置云电脑的主机名称。仅支持设置 AD 办公网络下,操作系统类型是 Windows 的云电脑。展开详情 示例值:testhost |
MultiResourceboolean | 是否为多台共享类型的共享型云电脑。 示例值:false枚举值:truefalse |
ExclusiveTypestring | 创建静态池。当参数 示例值:Exclusive |
GroupAmountinteger<int32> | 创建单台共享型云电脑的数量。只有当 示例值:1 |
SessionTypestring | 会话类型。 示例值:SingleSession枚举值:SingleSessionMultipleSession参考取值来源: DescribeDesktopGroupSessions |
TimerGroupIdstring | 定时任务组 ID。 示例值:ccg-0caoeogrk9m5**** |
SnapshotPolicyIdstring | 自动快照策略 ID。 示例值:sp-28mp6my0l6zow****参考取值来源: CreateAutoSnapshotPolicy DescribeAutoSnapshotPolicy |
UserOuPathstring | 参考取值来源: ListOfficeSiteUsers |
返回参数
字段名称 | 字段详情 |
---|---|
DesktopGroupIdstring | 共享型云电脑 ID。 示例值:dg-2i8qxpv6t1a03**** |
RequestIdstring | 请求 ID。 示例值:3EB7FCEE-D731-4948-85A3-4B2C341CA983 |
OrderIdsarray<string> | 订单 ID。 |
DesktopGroupIdsarray<string> | 共享型云电脑 ID 列表。 |