文档首页 > > API参考> 桌面> 创建桌面

创建桌面

分享
更新时间: 2019/07/10 GMT+08:00

功能介绍

创建桌面,并将此桌面分配给用户,当桌面创建成功后用户可以登录使用。作为异步接口,调用成功,只是说明云桌面服务后台收到了创建请求,桌面是否创建成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询

URI

  • URI格式

    POST /v1.0/{project_id}/desktops

  • URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    string

    用户ID。

请求

  • Request Body参数说明

    参数

    是否必选

    类型

    说明

    desktops

    列表数据结构[1]

    创建桌面使用的参数列表。当前不支持批量创建,调用一次接口只支持创建一台桌面。

    email_notification

    boolean

    创建成功后是否发送邮件通知桌面用户,默认为true。此参数仅在开通云桌面服务的domain_type为LOCAL_AD时有效,为LITE_AD时无效,因为LITE_AD首次创建桌面时必须发送邮件通知桌面用户修改登录密码。取值为:

    • true:发送邮件;
    • false:不发送邮件。

    tags

    列表数据结构[7]

    桌面的标签信息。

[1] desktops 字段数据结构说明

名称

是否必选

参数类型

说明

user_name

string

桌面所属的用户,当桌面创建成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-20]。

user_email

string

合法用户邮箱,桌面创建成功后系统会通过发送邮件的方式通知用户。

product_id

string

产品套餐ID。

image_id

string

镜像ID,用于私有镜像创建桌面场景,配合product_id使用。

root_volume

字典数据结构[3]

桌面系统盘相关配置。

data_volumes

列表数据结构[4]

桌面数据盘相关配置。

computer_name

string

桌面计算机名(操作系统可见),计算机名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_),并且使用小写字母或者大写字母开头,长度范围为[1-15]。

user_group

string

桌面用户所属的用户组,有以下两种取值:

ADMINISTRATORS:管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。

USERS:标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。

security_groups

列表数据结构[2]

桌面使用的安全组,如果不指定则默认使用桌面代理中指定的安全组。

nics

列表数据结构[5]

桌面对应的网卡信息,如果不指定则使用默认网卡。

availability_zone

string

可用分区。将桌面创建到指定的可用分区。如果不指定则使用系统随机的可用分区。可用分区信息可从区域及终端节点获取。

ou_name

string

此参数仅在开通云桌面服务的domain_type为LOCAL_AD时有效,LITE_AD不需要设置此参数值。只允许输入汉字,半角字母,数字,空格,以及-_/$!@&*?.范围内的特殊字符,字符范围是1~255,OU名称不能包含分隔符(/),多级OU使用/隔开,最多支持五级,/前后不能有空格,例如3级的OU格式:ab/cd/ef

[2] security_groups 字段数据结构说明

名称

是否必选

参数类型

说明

id

string

桌面使用的安全组ID。

[3] root_volume 字段数据结构说明

名称

是否必选

参数类型

说明

type

string

桌面系统盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。

SATA:SATA磁盘类型。

SSD:SSD磁盘类型。

size

integer

系统盘大小,容量单位为GB,输入大小范围为[80-32768],且不小于镜像中系统盘的最小(min_disk属性)值。

[4] data_volumes 字段数据结构说明

名称

是否必选

参数类型

说明

type

string

桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。

SATA:SATA磁盘类型。

SSD:SSD磁盘类型。

size

integer

数据盘大小,容量单位为GB,输入大小范围为[100-32768]。

[5] nics字段数据结构说明

名称

是否必选

参数类型

说明

subnet_id

string

网卡对应的子网ID,如果指定了nics字段,则subnet_id必选。

ip_address

string

IP地址,不填或空字符串将自动分配。

[7] tags字段数据结构说明

名称

是否必选

参数类型

说明

key

string

标签的键,不能为空,最大长度36个unicode字符。大小写字母,数字,中划线“-”,下划线“_”。

value

string

标签的值,最大长度43个unicode字符。大小写字母,数字,中划线“-”,下划线“_”。

  • 请求样例

    域类型为LITE_AD时:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    POST /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/desktops
    Request Body:
    {
        "desktops": [{
            "user_name": "test",
            "user_group": "USERS",
            "user_email": "test@test.com",
            "product_id": "workspace.c2.large.windows",
            "image_id": "66b9760c-02f0-4e3f-9946-4315cf299dc5",
            "computer_name": "test",
            "security_groups": [{
                "id": "631e70c6-c788-4522-8a26-9ef0f98c546a"
            }],
            "root_volume": {
                "type": "SATA",
                "size": 80
            },
            "data_volumes": [{
                "type": "SATA",
                "size": 100
            }],
            "nics": [{
                "subnet_id": "c962adaa-55b2-42ef-8e40-fd812221a96d"
            },
            {
                "subnet_id": "ebb535f7-5730-496c-b26a-601ddfffd2fe",
                "ip_address": "192.168.0.65"
            }],
            "availability_zone": "az01"
        }], 
        "tags": [{ 
                 "key": "key1",
                "value": "value1"
             }, 
             { 
                 "key": "key2", 
                 "value": "value2" 
         }]
    }
    

    域类型为LOCAL_AD时:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    POST /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/desktops
    Request Body: 
    { 
        "desktops": [{ 
            "user_name": "test", 
            "user_group": "USERS", 
            "user_email": "test@test.com", 
            "product_id": "workspace.c2.large.windows",
            "image_id": "66b9760c-02f0-4e3f-9946-4315cf299dc5", 
            "computer_name": "test", 
            "security_groups": [{ 
                "id": "631e70c6-c788-4522-8a26-9ef0f98c546a" 
            }], 
            "root_volume": { 
                "type": "SATA", 
                "size": 80 
            }, 
            "data_volumes": [{ 
                "type": "SATA", 
                "size": 100 
            }], 
            "nics": [{ 
                "subnet_id": "c962adaa-55b2-42ef-8e40-fd812221a96d" 
            }, 
            { 
                "subnet_id": "ebb535f7-5730-496c-b26a-601ddfffd2fe", 
                "ip_address": "192.168.0.65" 
            }], 
            "availability_zone": "az01", 
            "ou_name": "abc"
        }], 
        "email_notification": false,
        "tags": [{ 
                 "key": "key1",
                "value": "value1"
             }, 
             { 
                 "key": "key2", 
                 "value": "value2" 
         }]
    }
    

响应

  • 要素说明

    名称

    类型

    说明

    job_id

    string

    创建桌面任务ID。用户可以使用该ID对任务执行情况进行查询。

  • 响应样例
    1
    2
    3
    {
       "job_id": "a25e3d3f-8a8e-4789-bd3f-a04e230640fd"
    }
    

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    由于包含语法错误,当前请求无法被服务器理解。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    500 Internal Server Error

    服务内部错误,具体返回错误码请参见错误码说明

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

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

跳转到云社区