为用户创建一台或多台云桌面。
接口说明
1、创建云桌面前,请先完成以下准备工作:
- 已创建工作区和对应的用户。具体操作,请参见:
- 已调用CreateBundle创建桌面模板或确认使用已有桌面模板。
- 已调用CreatePolicyGroup创建策略或确认使用已有策略。
2、新建桌面后自动执行自定义命令脚本。UserCommands字段可配置自定义命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:CreateDesktops | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。 | cn-hangzhou |
GroupId | string | 否 | 桌面组ID。 | dg-boyczi8enfyc5**** |
BundleId | string | 是 | 桌面模板ID。 | b-je9hani001wfn**** |
DesktopName | string | 否 | 云桌面名称。命名规则如下:
| testDesktopName |
UserName | string | 否 | 此参数不开放使用。 | To be hidden. |
VpcId | string | 否 | 此参数不开放使用。 | To be hidden. |
Amount | integer | 否 | 创建的云桌面数量。取值范围为1~300,默认值为1。 | 1 |
DirectoryId | string | 否 | 此参数不开放使用。 | To be hidden. |
OfficeSiteId | string | 是 | 工作区ID。 | cn-hangzhou+os-c5cy7q578s8jc**** |
PolicyGroupId | string | 是 | 策略ID。 | system-all-enabled-policy |
ChargeType | string | 否 | 云桌面的计费方式。 枚举值:
| PrePaid |
Period | integer | 否 | 购买资源的时长。单位由
| 1 |
PeriodUnit | string | 否 | 包年包月计费方式的时长单位。 枚举值:
| Month |
AutoPay | boolean | 否 | 是否自动支付。 枚举值:
| false |
AutoRenew | boolean | 否 | 是否自动续费。当参数 枚举值:
| false |
PromotionId | string | 否 | 优惠活动ID。 | 23141 |
UserAssignMode | string | 否 | 桌面分配模式。 说明如果未设置 EndUserId ,创建的云桌面不会分配给用户。枚举值:
| ALL |
Hostname | string | 否 | 自定义设置云桌面的主机名称。仅支持设置AD工作区下,操作系统类型是Windows的云桌面。 主机名称的命名规则如下:
创建多台云桌面时,可以使用
| testhost |
EndUserId | array | 否 | 授权使用云桌面的用户ID,即将桌面分配给用户。可设置1~100个。
| |
string | 否 | 授权使用云桌面的用户ID,即将桌面分配给用户。
| test1 | |
Tag | array | 否 | 标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签键。可设置1~20个。 | TestKey |
Value | string | 否 | 标签值。可设置1~20个。 | TestValue |
DesktopNameSuffix | boolean | 否 | 批量创建桌面时,桌面名称是否自动增加后缀。 枚举值:
| false |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 枚举值:
| false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。 | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
UserCommands | array | 否 | 用户自定义命令脚本数据。 | |
object | 否 | 用户自定义命令脚本数据。 | ||
ContentEncoding | string | 否 | 命令内容(CommandContent)的编码方式。 枚举值:
| Base64 |
Content | string | 否 | 命令内容。 | bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm**** |
ContentType | string | 否 | 运维命令的语言类型。 枚举值:
| RunPowerShellScript |
BundleModels | array | 否 | 桌面模板。 | |
object | 否 | 桌面模板。 | ||
BundleId | string | 否 | 桌面模板ID。 | b-je9hani001wfn**** |
Amount | integer | 否 | 创建的云桌面数量。取值范围为1~300,默认值为0。 | 1 |
EndUserIds | array | 否 | 桌面分配用户列表。 | |
string | 否 | 用户名称。 | Alice | |
DesktopName | string | 否 | 云桌面名称。 | testDesktopName |
Hostname | string | 否 | 自定义设置云桌面的主机名称。仅支持设置AD工作区下,操作系统类型是Windows的云桌面。 主机名称的命名规则如下:
创建多台云桌面时,可以使用
| testhost |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 | false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。 | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": "123456789",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"DesktopId": [
"[\"ecd-gx2x1dhsmucyy****\"]"
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2022-08-08 | OpenAPI 入参发生变更 | |||||
|