ModifyDesktopGroup - 修改云电脑池

修改云电脑池。

接口说明

创建云电脑池后,系统将根据设置的云电脑池伸缩策略以及终端用户连接云电脑的情况,在云电脑池中自动创建对应数量的云电脑,这些云电脑将统一使用同一云电脑模板和安全策略。在不同场景下,您可以根据需要修改云电脑池配置,包括云电脑池名称、云电脑模板、关联的策略等。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
DesktopGroupIdstring

云电脑池 ID。

dg-2i8qxpv6t1a03****
OwnBundleIdstring

云电脑模板 ID。

b-7t275tpgjueeu****
PolicyGroupIdstring

策略 ID。

pg-53iyi2aar0nd6****
DesktopGroupNamestring

云电脑池名称。

desktopGroupName1
ScaleStrategyIdstring

伸缩策略组 ID。

说明 该参数暂未开放使用。
s-kakowkdl****
KeepDurationlong

会话断开连接后继续保留的时间。单位为毫秒,取值范围为 180000(3 分钟)~345600000(4 天)。取值为 0 时,表示始终保留。

当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。

180000
Commentsstring

备注信息。

comment
MinDesktopsCountinteger

包年包月云电脑池内自动创建云电脑的上限。即当参数ChargeType取值为PrePaid时才生效,且为必选值。默认值为 1,取值范围为 0~MaxDesktopsCount

1
MaxDesktopsCountinteger

按量付费云电脑池内能容纳的云电脑最大数量。取值范围:0~500。

10
AllowAutoSetupinteger

是否允许包年包月云电脑池自动创建云电脑。即当参数ChargeType取值为PrePaid时才生效,且为必选值。

枚举值:
  • 0不允许
  • 1允许
1
AllowBufferCountinteger

按量付费云电脑池内允许预留的云电脑数量。当参数ChargeType取值为PostPaid时才生效,且为必选值。取值范围:

  • 0:不预留
  • N:预留 N 台(1≤N≤100)
说明 如果不预留可用云电脑,当终端用户发起连接请求时,系统需要先创建并启动云电脑,然后分配给用户,所需时间相对较长。建议您根据需要预留一定数量的云电脑,保证终端用户的使用体验。
1
ResetTypelong

云电脑重置类型。

枚举值:
  • 0不重置
  • 1只重置系统盘
  • 2只重置用户磁盘
  • 3重置系统盘和用户磁盘
0
LoadPolicylong

多会话云电脑池的负载均衡策略。

说明 该参数暂未开放使用。
枚举值:
  • 0深度优先
  • 1广度优先
0
BindAmountlong

多会话云电脑池中每台云电脑允许的并发会话数。

说明 该参数暂未开放使用。
2
ImageIdstring

镜像 ID。

desktopimage-windows-server-2016-64-ch
Classifystring

云电脑池的类型。

说明 该参数暂未开放使用。
枚举值:
  • teacher教师云电脑池
  • student学生云电脑池
teacher
RatioThresholdfloat

会话占用率阈值,用作多会话云电脑池的自动伸缩触发条件。会话占用率的计算公式为:

会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%

当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。

说明 该参数暂未开放使用。
0.85
ConnectDurationlong

会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。取值范围:900000(15 分钟)~345600000(4 天)。

900000
IdleDisconnectDurationlong

用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。取值范围为 360000(6 分钟)~3600000(60 分钟)。

在达到该时长的 30 秒前,会话中的终端用户将收到保存文档数据的提示消息,此时终端用户需及时保存文档数据,避免丢失。

说明 仅适用于镜像版本号不低于 1.0.2 的云电脑。
360000
DisableSessionConfigboolean

是否禁用会话管理。

true
StopDurationlong

空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。

300000
ProfileFollowSwitchboolean

是否开启用户数据漫游。

说明 该参数暂未开放使用。
false
FileSystemIdstring

用户数据漫游功能使用的 NAS 文件系统 ID。

说明 该参数暂未开放使用。
04f314****
PolicyGroupIdsarray

策略组 ID 列表。

string

策略组 ID。

pg-gx2x1dhsmthe9****
BuyDesktopsCountinteger
  • 对于包年包月云电脑池:购买云电脑数量。取值范围:0~200。
  • 对于按量付费云电脑池:池内云电脑最小创建数量。默认值为 1,取值范围为 0~MaxDesktopsCount
5

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史