ModifyDesktopGroup - 修改桌面组

修改桌面组。

接口说明

创建桌面组后,系统将根据设置的桌面组伸缩策略以及终端用户连接云桌面的情况,在桌面组中自动创建对应数量的云桌面,这些云桌面将统一使用同一桌面模板和安全策略。在不同场景下,您可以根据需要修改桌面组配置,实现云桌面的统一管理,例如:

  • 当前桌面组名称无法很好地标识桌面(桌面组内的云桌面名称均与桌面组名称一致),您可以修改桌面组名称(DesktopGroupName)。
  • 当前云桌面的vCPU和内存规格过小,无法满足工作需要,您可以将当前桌面模板修改为包含更高规格配置的其它桌面模板(OwnBundleId)。
  • 当前桌面组关联的安全策略不合适,无法满足安全管理需求,您可以将当前安全策略修改为其它安全策略(PolicyGroupId)。
  • 当前桌面组内的云桌面数量不够,无法满足终端用户的使用需求,您可以调整伸缩策略,修改相关参数(MinDesktopsCount、MaxDesktopsCount、AllowBufferCount等)。

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
DesktopGroupIdstring

桌面组ID。

dg-2i8qxpv6t1a03****
OwnBundleIdstring

桌面模板ID。

b-7t275tpgjueeu****
PolicyGroupIdstring

策略ID。

pg-53iyi2aar0nd6****
DesktopGroupNamestring

桌面组名称。

desktopGroupName1
ScaleStrategyIdstring

伸缩策略组ID。

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

终端用户断开桌面连接后,桌面的保留时长。单位为ms。

1000
Commentsstring

备注信息。

test
MinDesktopsCountinteger

桌面组计费方式为包年包月时,设置桌面组必须保持的最小桌面数量。即当参数ChargeType取值为PrePaid时才生效,且为必选值。默认值为1,取值范围为0~MaxDesktopsCount。

1
MaxDesktopsCountinteger

桌面组允许容纳的最大桌面数量。最大值为100。

10
AllowAutoSetupinteger

桌面组计费方式为包年包月时,设置是否允许自动创建桌面。即当参数ChargeType取值为PrePaid时才生效,且为必选值。取值范围:

  • 0:不允许。
  • 1:允许。
1
AllowBufferCountinteger

桌面组计费方式为按量付费时,设置允许预留的桌面数量。即当参数ChargeType取值为PostPaid时才生效,且为必选值。取值范围: 0:不预留。 N:预留N台,1≤N≤MaxDesktopsCount。

1
ResetTypelong

桌面重置类型。

0
LoadPolicylong

多会话桌面组负载策略。

0
BindAmountlong

多会话桌面组中每台桌面允许的会话数。

1
ImageIdstring

镜像ID。

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

桌面池的业务线类型。

teacher
RatioThresholdnumber

多会话桌面自动伸缩策略的会话用量阈值。

0.5
ConnectDurationlong

会话持续最大时长。 单位:毫秒。

600000
IdleDisconnectDurationlong

会话最大空闲时长,单位:毫秒。

120000
DisableSessionConfigboolean

是否禁用会话管理。

true
StopDurationlong

空闲关机时长,单位:毫秒。

180000
ProfileFollowSwitchboolean

数据漫游开关。

false
FileSystemIdstring

NAS文件系统ID。

04f314****
PolicyGroupIdsarray
string

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

阿里云首页 无影云桌面 相关技术圈