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

接口说明

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

调试

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

请求参数

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

系统规定参数。取值：CreateDesktops。
BundleId String 是 b-je9hani001wfn****

桌面模板ID。
EndUserId.N RepeatList 是 123456789

授权使用云桌面的用户ID。可设置一个或多个用户，N的取值范围：1~100。

说明 在同一时段内，只有一个用户可以使用该桌面。
DirectoryId String 是 cn-hangzhou+dir-jedbpr4sl9l37****

用户目录ID。
PolicyGroupId String 是 system-all-enabled-policy

策略ID。
RegionId String 是 cn-hangzhou

地域ID。
ChargeType String 否 PrePaid

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

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

默认值：PostPaid。
AutoPay Boolean 否 false

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

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

默认值：true。
Period Integer 否 1

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

  • 如果PeriodUnit为Month，该参数的取值范围：{“1”, “2”, “3”, “6”}。
  • 如果PeriodUnit为Year，该参数的取值范围：{“1”, “2”, “3”, “4”, “5”}。
PeriodUnit String 否 Month

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

  • Month：月
  • Year：年
DesktopName String 否 testDesktopName

云桌面名称。
Amount Integer 否 1

创建的云桌面数量。取值范围：1~20

默认值：1
Tag.N.Key String 否 TestKey

标签键。N的取值范围为：1~20。
Tag.N.Value String 否 TestValue

标签值。N的取值范围为：1~20。
AutoRenew Boolean 否 false

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

取值范围：

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

默认值： false。

返回数据

名称 类型 示例值 描述
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
&AutoPay=false
&BundleId=b-je9hani001wfn****
&ChargeType=PrePaid
&DirectoryId=cn-hangzhou+dir-jedbpr4sl9l37****
&EndUserId.1=123456789
&Period=1
&PeriodUnit=Mouth
&PolicyGroupId=system-all-enabled-policy
&<公共请求参数>

正常返回示例

XML格式 

<CreateDesktopsResponse> 
      <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>
      <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
      <OrderId>123456789</OrderId>
</CreateDesktopsResponse>

JSON格式 

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

错误码

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