调用CreateDesktops创建一台或多台云桌面。

接口说明

创建云桌面前,请先完成以下准备工作:

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDesktops

系统规定参数。取值:CreateDesktops。

BundleId String b-je9hani001wfn****

桌面模板ID。

PolicyGroupId String system-all-enabled-policy

策略ID。

RegionId String cn-hangzhou

地域ID。

OfficeSiteId String cn-hangzhou+os-c5cy7q578s8jc****

工作区ID。

ChargeType String PrePaid

云桌面的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid。

AutoPay Boolean false

是否自动支付。取值范围:

  • true:自动支付。请确保账户余额充足,否则会产生异常订单。
  • false:只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。

默认值:true。

EndUserId.N RepeatList 123456789

授权使用云桌面的用户ID,即将桌面分配给用户。可设置一个或多个用户,N的取值范围:1~100。

  • 在同一时段内,只有一个用户可以使用该桌面。
  • 如果未设置EndUserId,创建的云桌面不会分配给任何用户。
Period Integer 1

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

  • 如果PeriodUnitMonth,该参数的取值范围:{“1”, “2”, “3”, “6”}。
  • 如果PeriodUnitYear,该参数的取值范围:{“1”, “2”, “3”, “4”, “5”}。
PeriodUnit String Month

包年包月计费方式的时长单位。取值范围:

  • Month:月
  • Year:年

默认值:月。

DesktopName String testDesktopName

云桌面名称。

Amount Integer 1

创建的云桌面数量。取值范围为1~300,默认值为1。

AutoRenew Boolean false

是否自动续费。当参数ChargeType取值为PrePaid时才生效。

取值范围:

  • true:自动续费。续费时长与购买设置的时长保持一致。
  • false:不自动续费。

默认值: false。

UserAssignMode String ALL

桌面分配模式。默认为ALL。

  • ALL:如果设置了EndUserId,则将创建的云桌面分配给每个指定的用户。
  • PER_USER:如果设置了EndUserId,则将创建的云桌面平均分配给指定的用户。此时需确保Amount的值可以被EndUserId的个数(即N)整除。
说明 如果未设置EndUserId,创建的云桌面不会分配给用户。
Hostname String testhost

自定义设置云桌面的主机名称。仅支持设置AD工作区下,操作系统类型是Windows的云桌面。

主机名称的命名规则如下:

  • 长度为2~15个字符。
  • 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。

创建多台云桌面时,可以使用name_prefix[begin_number,bits]name_suffix的命名格式为多台云桌面统一命名。例如,设置Hostname的取值为ecd--1,4-test,则第一台云桌面主机名称为ecd-0001-test,第二台云桌面主机名称为ecd-0002-test,依次类推。

  • name_prefix:主机名称的前缀。
  • [begin_number,bits]:主机名称中的有序数字。begin_number为起始数字,取值支持0~999999,默认值为0;bits为数字位数,取值支持1~6,默认值为6。
  • name_suffix:主机名称的后缀。
Tag.N.Key String TestKey

标签键。N的取值范围为:1~20。

Tag.N.Value String TestValue

标签值。N的取值范围为:1~20。

返回数据

名称 类型 示例值 描述
DesktopId List ["ecd-gx2x1dhsmucyy****"]

云桌面ID。返回集合信息,如果一次调用创建了多个云桌面,将返回多个云桌面ID。

OrderId String 123456789

订单ID。

说明 当请求参数ChargeType取值为PrePaid时,返回该参数。
RequestId String 3EB7FCEE-D731-4948-85A3-4B2C341CA983

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=CreateDesktops
&BundleId=b-je9hani001wfn****
&PolicyGroupId=system-all-enabled-policy
&RegionId=cn-hangzhou
&OfficeSiteId=cn-hangzhou+os-c5cy7q578s8jc****
&EndUserId.1=123456789
&<公共请求参数>

正常返回示例

XML格式

<CreateDesktopsResponse>
  <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>
  <DesktopId>["ecd-gx2x1dhsmucyy****"]</DesktopId>
</CreateDesktopsResponse>

JSON格式

{
    "CreateDesktopsResponse": {
        "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
        "DesktopId": "[\"ecd-gx2x1dhsmucyy****\"]"
    }
}