调用CreateDesktops创建一台或多台云桌面。
接口说明
创建云桌面前,请先完成以下准备工作:
- 已创建工作区和对应的用户。具体操作,请参见:
- 已调用CreateBundle创建桌面模板或确认使用已有桌面模板。
- 已调用CreatePolicyGroup创建策略或确认使用已有策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDesktops |
系统规定参数。取值:CreateDesktops。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
BundleId | String | 是 | b-je9hani001wfn**** |
桌面模板ID。 |
DesktopName | String | 否 | testDesktopName |
云桌面名称。 |
Amount | Integer | 否 | 1 |
创建的云桌面数量。取值范围为1~300,默认值为1。 |
OfficeSiteId | String | 是 | cn-hangzhou+os-c5cy7q578s8jc**** |
工作区ID。 |
PolicyGroupId | String | 是 | system-all-enabled-policy |
策略ID。 |
ChargeType | String | 否 | PrePaid |
云桌面的计费方式。取值范围:
默认值:PostPaid。 |
Period | Integer | 否 | 1 |
购买资源的时长。单位由
|
PeriodUnit | String | 否 | Month |
包年包月计费方式的时长单位。取值范围:
默认值:月。 |
AutoPay | Boolean | 否 | false |
是否自动支付。取值范围:
默认值:true。 |
AutoRenew | Boolean | 否 | false |
是否自动续费。当参数ChargeType取值为PrePaid时才生效。 取值范围:
默认值: false。 |
UserAssignMode | String | 否 | ALL |
桌面分配模式。默认为ALL。
说明 如果未设置EndUserId,创建的云桌面不会分配给用户。
|
Hostname | String | 否 | testhost |
自定义设置云桌面的主机名称。仅支持设置AD工作区下,操作系统类型是Windows的云桌面。 主机名称的命名规则如下:
创建多台云桌面时,可以使用
|
DesktopNameSuffix | Boolean | 否 | false |
批量创建桌面时,桌面名称是否自动增加后缀。
|
EndUserId.N | String | 否 | test1 |
授权使用云桌面的用户ID,即将桌面分配给用户。可设置一个或多个用户,N的取值范围:1~100。
|
Tag.N.Key | String | 否 | TestKey |
标签键。N的取值范围为:1~20。 |
Tag.N.Value | String | 否 | TestValue |
标签值。N的取值范围为:1~20。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
OrderId | String | 123456789 |
订单ID。 说明 当请求参数ChargeType取值为PrePaid时,返回该参数。
|
RequestId | String | 3EB7FCEE-D731-4948-85A3-4B2C341CA983 |
请求ID。 |
DesktopId | Array of String | ["ecd-gx2x1dhsmucyy****"] |
云桌面ID。返回集合信息,如果一次调用创建了多个云桌面,将返回多个云桌面ID。 |
示例
请求示例
https://ecd.cn-hangzhou.aliyuncs.com/?Action=CreateDesktops
&RegionId=cn-hangzhou
&GroupId=hide
&BundleId=b-je9hani001wfn****
&DesktopName=testDesktopName
&UserName=hide
&VpcId=hide
&Amount=1
&DirectoryId=hide
&OfficeSiteId=cn-hangzhou+os-c5cy7q578s8jc****
&PolicyGroupId=system-all-enabled-policy
&ChargeType=PrePaid
&Period=1
&PeriodUnit=Month
&AutoPay=false
&AutoRenew=false
&PromotionId=hide
&UserAssignMode=ALL
&Hostname=testhost
&EndUserId=["test1"]
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&DesktopNameSuffix=false
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateDesktopsResponse>
<OrderId>123456789</OrderId>
<RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>
<DesktopId>["ecd-gx2x1dhsmucyy****"]</DesktopId>
</CreateDesktopsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"OrderId" : "123456789",
"RequestId" : "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
"DesktopId" : [ "[\"ecd-gx2x1dhsmucyy****\"]" ]
}