创建一个桌面组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。 | cn-hangzhou |
BundleId | string | 是 | 桌面模板ID。 | b-je9hani001wfn**** |
OfficeSiteId | string | 是 | 工作区ID。 | cn-hangzhou+os-c5cy7q578s8jc**** |
PolicyGroupId | string | 是 | 策略ID。 | pg-9c2d6t2dwflqr**** |
DesktopGroupName | string | 否 | 桌面组名称。 | desktopGroupName1 |
DirectoryId | string | 否 | 目录 ID。 | hide |
ScaleStrategyId | string | 否 | 伸缩策略ID。 说明该参数暂未开放使用。 | hide |
VpcId | string | 否 | 所在的 VPC ID。 | hide |
DefaultInitDesktopCount | integer | 否 | 创建桌面组时默认生成的桌面数量。默认值为1。 | 1 |
KeepDuration | long | 否 | 终端用户断开桌面连接后,桌面的保留时长。单位为ms。 | 6000 |
ChargeType | string | 是 | 云桌面的计费方式。 枚举值:
| PrePaid |
Period | integer | 否 | 购买资源的时长。单位由PeriodUnit指定。当参数ChargeType取值为PrePaid时才生效,且为必选值。
| 1 |
PeriodUnit | string | 否 | 包年包月计费方式的时长单位。 枚举值:
| Month |
OwnType | integer | 否 | 桌面组类型。 枚举值:
| 0 |
AutoPay | boolean | 否 | 是否自动支付。 | true |
Comments | string | 否 | 备注信息。 | test |
MinDesktopsCount | integer | 否 | 桌面组计费方式为包年包月时,设置桌面组必须保持的最小桌面数量。即当参数ChargeType取值为PrePaid时才生效,且为必选值。默认值为1,取值范围为0~MaxDesktopsCount。 | 1 |
MaxDesktopsCount | integer | 否 | 桌面组允许容纳的最大桌面数量,取值范围:0-200。 | 50 |
AllowAutoSetup | integer | 否 | 桌面组计费方式为包年包月时,设置是否允许自动创建桌面。即当参数ChargeType取值为PrePaid时才生效,且为必选值。 枚举值:
| 1 |
AllowBufferCount | integer | 否 | 桌面组计费方式为按量付费时,设置允许预留的桌面数量。即当参数ChargeType取值为PostPaid时才生效,且为必选值。 取值范围: 0:不预留 N:预留N台 (1≤N≤100) | 1 |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
EndUserIds | array | 否 | 授权使用桌面组的用户数组。 | |
string | 否 | 授权使用桌面组的用户。 | alice | |
ResetType | long | 否 | 桌面重置类型。 枚举值:
| 0 |
LoadPolicy | long | 否 | 多会话桌面组负载策略。 枚举值:
| 0 |
BindAmount | long | 否 | 多会话桌面组中,每台桌面允许的会话数。 | 1 |
Classify | string | 否 | 桌面池的分类。 枚举值:
| teacher |
AllClassifyUsers | boolean | 否 | 增加所有的桌面池的分类的用户。 | Alice |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 | false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。 | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
RatioThreshold | float | 否 | 会话占用率阈值,用作多会话桌面组的自动伸缩触发条件。会话占用率的计算公式为 | 0.5 |
ConnectDuration | long | 否 | 会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。只有池化模式下需要传入此参数。 | 300000 |
IdleDisconnectDuration | long | 否 | 会话处于空闲状态(即没有键盘或鼠标输入)的最大时长。会话空闲时长达到此值时将自动断开连接。单位:毫秒。只有池化模式下需要传入此参数。 | 300000 |
StopDuration | long | 否 | 空闲关机时间。当桌面空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。 | 300000 |
ProfileFollowSwitch | boolean | 否 | 开启数据漫游 | false |
FileSystemId | string | 否 | 开启数据漫游功能使用的NAS文件系统 | 04f314**** |
BuyDesktopsCount | integer | 否 | 购买桌面数,取值范围:0-200。 | 3 |
返回参数
示例
正常返回示例
JSON
格式
{
"DesktopGroupId": "dg-2i8qxpv6t1a03****",
"RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
"OrderIds": [
"123456789"
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-08-24 | API 内部配置变更,不影响调用 | |||
|