接口说明
创建共享型云电脑后，系统将根据设置的共享型云电脑伸缩策略以及终端用户连接云电脑的情况，在共享型云电脑中自动创建对应数量的云电脑，这些云电脑将统一使用同一云电脑模板和安全策略。在不同场景下，您可以根据需要修改共享型云电脑配置，包括共享型云电脑名称、云电脑模板、关联的策略等。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
RegionIdstring | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 示例值:cn-hangzhou |
DesktopGroupIdstring | 共享型云电脑 ID。 示例值:dg-2i8qxpv6t1a03****参考取值来源: CreateDesktopGroup AddUserToDesktopGroup DescribeDesktopGroups |
OwnBundleIdstring | 云电脑模板 ID。 示例值:b-7t275tpgjueeu****参考取值来源: CreateBundle DescribeBundles |
PolicyGroupIdstring | 策略 ID。 示例值:pg-53iyi2aar0nd6****参考取值来源: ClonePolicyGroup CreatePolicyGroup DescribePolicyGroups GetDesktopGroupDetail |
DesktopGroupNamestring | 共享型云电脑名称。 示例值:desktopGroupName1参考取值来源: GetDesktopGroupDetail DescribeDesktopGroups |
ScaleStrategyIdstring | 伸缩策略组 ID。展开详情 示例值:s-kakowkdl**** |
KeepDurationinteger<int64> | 会话断开连接后继续保留的时间。单位为毫秒，取值范围为 180000（3 分钟）~345600000（4 天）。取值为 0 时，表示始终保留。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:180000 |
Commentsstring | 备注信息。 示例值:comment |
MinDesktopsCountinteger<int32> | 包年包月共享型云电脑内自动创建云电脑的上限。即当参数 示例值:1取值 <= 500 |
MaxDesktopsCountinteger<int32> | 按量付费共享型云电脑内能容纳的云电脑最大数量。取值范围：0~500。 示例值:10取值 <= 1000 |
AllowAutoSetupinteger<int32> | 是否允许包年包月共享型云电脑自动创建云电脑。即当参数 示例值:1枚举值:01取值 <= 1 |
AllowBufferCountinteger<int32> | 按量付费共享型云电脑内允许预留的云电脑数量。当参数 示例值:1取值 <= 1000 |
ResetTypeinteger<int64> | 云电脑重置类型。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:0枚举值:0123 |
LoadPolicyinteger<int64> | |
BindAmountinteger<int64> | |
ImageIdstring | 镜像 ID。 示例值:desktopimage-windows-server-2016-64-ch参考取值来源: UploadImage CopyImage CreateImage DescribeImages |
Classifystring | 共享型云电脑的类型。展开详情 示例值:teacher枚举值:teacherstudent |
RatioThresholdnumber<float> | 会话占用率阈值，用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为：展开详情 示例值:0.85 |
ConnectDurationinteger<int64> | 会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位：毫秒。取值范围：900000（15 分钟）~345600000（4 天）。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:900000参考取值来源: DescribeUserConnectionRecords |
IdleDisconnectDurationinteger<int64> | 用户会话建立连接后，如果在该最大时长内，始终没有任何键盘或鼠标操作，则该会话断开连接。单位：毫秒。取值范围为 360000（6 分钟）~3600000（60 分钟）。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:360000 |
DisableSessionConfigboolean | 是否禁用会话管理。 示例值:true |
StopDurationinteger<int64> | 空闲关机时间。当云电脑空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:300000 |
ProfileFollowSwitchboolean | 是否开启用户数据漫游。展开详情 示例值:false |
FileSystemIdstring | 用户数据漫游功能使用的 NAS 文件系统 ID。展开详情 示例值:04f314****参考取值来源: CreateNASFileSystem DescribeNASFileSystems |
PolicyGroupIdsarray<string> | 策略组 ID 列表。 子级条数 <= 5 |
BuyDesktopsCountinteger<int32> |
示例值:5 |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求 ID。 示例值:1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2022-11-22 | |||
| 2022-09-05 | |||
| 2022-08-19 | |||
| 2022-08-11 | |||
| 2022-08-11 | |||
| 2022-07-12 | |||
| 2021-11-04 |