修改共享型云电脑。
接口说明
创建共享型云电脑后,系统将根据设置的共享型云电脑伸缩策略以及终端用户连接云电脑的情况,在共享型云电脑中自动创建对应数量的云电脑,这些云电脑将统一使用同一云电脑模板和安全策略。在不同场景下,您可以根据需要修改共享型云电脑配置,包括共享型云电脑名称、云电脑模板、关联的策略等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| ecd:ModifyDesktopGroup | update | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou | 
| DesktopGroupId | string | 是 | 共享型云电脑 ID。 | dg-2i8qxpv6t1a03**** | 
| OwnBundleId | string | 否 | 云电脑模板 ID。 | b-7t275tpgjueeu**** | 
| PolicyGroupId | string | 否 | 策略 ID。 | pg-53iyi2aar0nd6**** | 
| DesktopGroupName | string | 否 | 共享型云电脑名称。 | desktopGroupName1 | 
| ScaleStrategyId | string | 否 | 伸缩策略组 ID。 说明 
该参数暂未开放使用。
 | s-kakowkdl**** | 
| KeepDuration | long | 否 | 会话断开连接后继续保留的时间。单位为毫秒,取值范围为 180000(3 分钟)~345600000(4 天)。取值为 0 时,表示始终保留。 当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。 | 180000 | 
| Comments | string | 否 | 备注信息。 | comment | 
| MinDesktopsCount | integer | 否 | 包年包月共享型云电脑内自动创建云电脑的上限。即当参数 | 1 | 
| MaxDesktopsCount | integer | 否 | 按量付费共享型云电脑内能容纳的云电脑最大数量。取值范围:0~500。 | 10 | 
| AllowAutoSetup | integer | 否 | 是否允许包年包月共享型云电脑自动创建云电脑。即当参数 枚举值: 
 | 1 | 
| AllowBufferCount | integer | 否 | 按量付费共享型云电脑内允许预留的云电脑数量。当参数 
 说明 
如果不预留可用云电脑,当终端用户发起连接请求时,系统需要先创建并启动云电脑,然后分配给用户,所需时间相对较长。建议您根据需要预留一定数量的云电脑,保证终端用户的使用体验。
 | 1 | 
| ResetType | long | 否 | 云电脑重置类型。 枚举值: 
 | 0 | 
| LoadPolicy | long | 否 | 多会话多台共享型云电脑的负载均衡策略。 说明 
该参数暂未开放使用。
 枚举值: 
 | 0 | 
| BindAmount | long | 否 | 多会话多台共享型云电脑中每台云电脑允许的并发会话数。 说明 
该参数暂未开放使用。
 | 2 | 
| ImageId | string | 否 | 镜像 ID。 | desktopimage-windows-server-2016-64-ch | 
| Classify | string | 否 | 共享型云电脑的类型。 说明 
该参数暂未开放使用。
 枚举值: 
 | teacher | 
| RatioThreshold | float | 否 | 会话占用率阈值,用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为: 
 当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。 说明 
该参数暂未开放使用。
 | 0.85 | 
| ConnectDuration | long | 否 | 会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。取值范围:900000(15 分钟)~345600000(4 天)。 | 900000 | 
| IdleDisconnectDuration | long | 否 | 用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。取值范围为 360000(6 分钟)~3600000(60 分钟)。 在达到该时长的 30 秒前,会话中的终端用户将收到保存文档数据的提示消息,此时终端用户需及时保存文档数据,避免丢失。 说明 
仅适用于镜像版本号不低于 1.0.2 的云电脑。
 | 360000 | 
| DisableSessionConfig | boolean | 否 | 是否禁用会话管理。 | true | 
| StopDuration | long | 否 | 空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。 | 300000 | 
| ProfileFollowSwitch | boolean | 否 | 是否开启用户数据漫游。 说明 
该参数暂未开放使用。
 | false | 
| FileSystemId | string | 否 | 用户数据漫游功能使用的 NAS 文件系统 ID。 说明 
该参数暂未开放使用。
 | 04f314**** | 
| PolicyGroupIds | array | 否 | 策略组 ID 列表。 | |
| string | 否 | 策略组 ID。 | pg-gx2x1dhsmthe9**** | |
| BuyDesktopsCount | integer | 否 | 
 | 5 | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|
