文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 创建桌面

更新时间：2024-12-27 GMT+08:00

查看PDF

创建桌面

功能介绍

创建桌面，并将此桌面分配给用户，当桌面创建成功后用户可以登录使用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/desktops

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
Content-Type	否	String	发送的实体的MIME类型。

表3 请求Body参数
参数	是否必选	参数类型	描述
desktop_type	是	String	云桌面类型。 DEDICATED：专属桌面，单用户。 SHARED: 多用户共享桌面。
availability_zone	否	String	可用分区。将桌面创建到指定的可用分区。如果不指定则使用系统随机的可用分区。
product_id	是	String	套餐ID。
image_type	是	String	镜像类型。默认值为private。 private：私有镜像。 gold：公共镜像。
image_id	是	String	镜像ID，用于私有镜像创建桌面场景，配合product_id使用。
root_volume	是	Volume object	系统盘。
data_volumes	否	Array of Volume objects	数据盘列表。
nics	否	Array of Nic objects	桌面对应的网卡信息，如果不指定则使用默认网卡。
security_groups	否	Array of SecurityGroup objects	桌面使用的安全组，如果不指定则默认使用桌面代理中指定的安全组。
desktops	否	Array of Desktop objects	创建桌面使用的参数列表。长度为1-100。当前不支持一批桌面不同配置，所有桌面的配置和第一台的一致，如果第一台未设置参数，则取外层的同名参数。
desktop_name	否	String	搭配size使用，当size为1时代表桌面名，位数1-15，当size大于1时代表桌面名前缀，位数：1-13。
desktop_ips	否	Array of strings	桌面指定分配的ip地址列表,最小为0，最大为100。
size	否	Integer	创建不分配用户的桌面的个数，和desktops不能同时生效，搭配desktop_name使用。
email_notification	否	Boolean	创建成功后是否发送邮件通知桌面用户，默认为true。
enterprise_project_id	否	String	企业项目ID，默认"0。"
tags	否	Array of Tag objects	标签列表。
apply_shared_vpc_dedicated_param	否	ApplySharedVpcDedicatedParam object	共享Vpc专线入参。
eip	否	Eip object	EIP信息。
desktop_name_policy_id	否	String	策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。

表4 Volume
参数	是否必选	参数类型	描述
type	是	String	桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 -SAS：高IO。 -SSD：超高IO。 -GPSSD：通用型SSD。
size	是	Integer	磁盘容量，单位GB。系统盘大小范围[80-32760]，数据盘范围[10-32760]，大小为10的倍数。

表5 Nic
参数	是否必选	参数类型	描述
subnet_id	是	String	网卡对应的子网ID。

表6 SecurityGroup
参数	是否必选	参数类型	描述
id	是	String	安全组ID。

表7 Desktop
参数	是否必选	参数类型	描述
user_name	是	String	桌面所属的用户，当桌面创建成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。
user_email	否	String	合法用户邮箱，桌面创建成功后系统会通过发送邮件的方式通知用户。
user_phone	否	String	合法用户手机号。
user_group	否	String	桌面用户所属的用户组。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。
computer_name	否	String	桌面名，桌面名必须保证唯一。桌面名称只允许输入大写字母、小写字母、中文、数字、中划线，以字母或数字开头、不能以中划线结尾，长度范围为1~15(中文字符长度为2，数字及英文字符长度为1)。
os_host_name	否	String	系统计算机名。
desktop_name_prefix	否	String	桌面名称前缀，不指定"computer_name"时生效。

表8 Tag
参数	是否必选	参数类型	描述
key	是	String	标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。
value	否	String	标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。

表9 ApplySharedVpcDedicatedParam
参数	是否必选	参数类型	描述
address	否	String	租户指定的共享Vpc专线地址。
port	否	Integer	租户指定共享Vpc专线地址端口。
availability_zone	否	Array of strings	开通服务资源使用的可用分区，默认随机使用2个可用区。

**表10** Eip
参数	是否必选	参数类型	描述
id	否	String	桌面绑定的EIP的id，有值时优先绑定EIP。
type	否	String	EIP的类型，5_bgp（全动态BGP），5_sbgp（静态BGP）。
charge_mode	否	String	eip带宽计费模式 TRAFFIC：按流量计费。 BANDWIDTH：按带宽计费。
bandwidth_size	否	Integer	带宽大小。

响应参数

状态码： 200

**表11** 响应Body参数
参数	参数类型	描述
job_id	String	创建云桌面总任务id。

状态码： 400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 403

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 404

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

{
  "desktop_type" : "DEDICATED",
  "image_type" : "gold",
  "image_id" : "a866298d-67db-44b0-a1f1-9d09bdddc20f",
  "root_volume" : {
    "type" : "SAS",
    "size" : 80
  },
  "availability_zone" : "az3.manage.x86",
  "desktops" : [ {
    "user_name" : "ljh-002",
    "user_group" : "administrators",
    "user_email" : "aaaaa@huawei.com"
  } ],
  "nics" : [ {
    "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55"
  } ],
  "product_id" : "workspace.c2.large.windows.2",
  "email_notification" : true
}

响应示例

状态码： 200

创建云桌面响应。

{
  "job_id" : "3979904c-7beb-4f34-835f-2fa989a5550a"
}

状态码

状态码	描述
200	创建云桌面响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 桌面

上一篇：桌面

下一篇：查询桌面列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建桌面

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线