CreateDesktopGroup - 创建桌面组

创建一个桌面组。

接口说明

操作前请完成以下操作:

  • 了解桌面组的功能场景、使用限制、伸缩策略等信息。更多信息,请参见桌面组概述
  • 创建工作区、用户、桌面模板、策略等资源。

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
BundleIdstring

桌面模板ID。

b-je9hani001wfn****
OfficeSiteIdstring

工作区ID。

cn-hangzhou+os-c5cy7q578s8jc****
PolicyGroupIdstring

策略ID。

pg-9c2d6t2dwflqr****
DesktopGroupNamestring

桌面组名称。

desktopGroupName1
DirectoryIdstring

目录 ID。

hide
ScaleStrategyIdstring

伸缩策略ID。

说明该参数暂未开放使用。
hide
VpcIdstring

所在的 VPC ID。

hide
DefaultInitDesktopCountinteger

创建桌面组时默认生成的桌面数量。默认值为1。

1
KeepDurationlong

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

6000
ChargeTypestring

云桌面的计费方式。

PrePaid
Periodinteger

购买资源的时长。单位由PeriodUnit指定。当参数ChargeType取值为PrePaid时才生效,且为必选值。

  • 如果PeriodUnit为Month,该参数的取值范围:
    • 1
    • 2
    • 3
    • 6
  • 如果PeriodUnit为Year,该参数的取值范围:
    • 1
    • 2
    • 3
    • 4
    • 5
1
PeriodUnitstring

包年包月计费方式的时长单位。

Month
OwnTypeinteger

桌面组类型。

0
AutoPayboolean

是否自动支付。

true
Commentsstring

备注信息。

test
MinDesktopsCountinteger

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

1
MaxDesktopsCountinteger

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

50
AllowAutoSetupinteger

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

1
AllowBufferCountinteger

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

1
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
EndUserIdsarray

授权使用桌面组的用户数组。

string

授权使用桌面组的用户。

alice
ResetTypelong

桌面重置类型。

0
LoadPolicylong

多会话桌面组负载策略。

0
BindAmountlong

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

1
Classifystring

桌面池的分类。

teacher
AllClassifyUsersboolean

增加所有的桌面池的分类的用户。

Alice
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
RatioThresholdnumber

会话占用率阈值,用作多会话桌面组的自动伸缩触发条件。会话占用率的计算公式为会话占用率 = 已绑定会话数 / (桌面资源总数 × 每台桌面支持的最多会话数) * 100%,当会话占用率达到该阈值时,触发新桌面的创建;未达到该阈值时,删除多余的桌面。

0.5
ConnectDurationlong

会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。只有池化模式下需要传入此参数。

300000
IdleDisconnectDurationlong

会话处于空闲状态(即没有键盘或鼠标输入)的最大时长。会话空闲时长达到此值时将自动断开连接。单位:毫秒。只有池化模式下需要传入此参数。

300000
StopDurationlong

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

300000
ProfileFollowSwitchboolean

开启数据漫游

false
FileSystemIdstring

开启数据漫游功能使用的NAS文件系统

04f314****

返回参数

名称类型描述示例值
object

返回信息集合。

DesktopGroupIdstring

桌面组ID。

dg-2i8qxpv6t1a03****
RequestIdstring

请求ID。

3EB7FCEE-D731-4948-85A3-4B2C341CA983
OrderIdsarray

订单ID。

string

订单ID。当请求参数ChargeType取值为PrePaid时,返回该参数。

123456789

示例

正常返回示例

JSON格式

{
  "DesktopGroupId": "dg-2i8qxpv6t1a03****",
  "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
  "OrderIds": [
    "123456789"
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-24API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
阿里云首页 无影云桌面 相关技术圈