创建桌面池

project_id

是

String

项目ID。

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

name

是

String

桌面池名称，桌面池名称必须保证唯一。桌面名称只允许输入中文、大写字母、小写字母、数字、中划线，长度范围为1~255。

type

是

String

桌面池类型，DYNAMIC：动态池，STATIC：静态池。

size

是

Integer

桌面池大小：当前桌面池要创建多少台桌面。

description

否

String

桌面池描述。

availability_zone

否

String

可用分区。将桌面创建到指定的可用分区。如果不指定则使用系统随机的可用分区。

product_id

是

String

套餐ID。

image_type

是

String

镜像类型。默认值为private。

• private：私有镜像。

• gold：公共镜像。

image_id

是

String

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

root_volume

是

VolumeInfo object

系统盘。

data_volumes

否

Array of VolumeInfo objects

数据盘列表。

vpc_id

否

String

创建桌面时的VPC ID。

subnet_ids

是

Array of strings

创建桌面使用的子网ID。

security_groups

否

Array of SecurityGroup objects

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

authorized_objects

否

Array of AuthorizedObjects objects

要授权的用户/用户组列表。

ou_name

否

String

OU名称，在对接AD时使用，需提前在AD中创建OU。

tags

否

Array of Tag objects

标签列表。

enterprise_project_id

否

String

企业项目ID，默认"0"

disconnected_retention_period

否

Integer

动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。

enable_autoscale

否

Boolean

桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。

autoscale_policy

否

AutoscalePolicy object

弹性伸缩策略。

desktop_name_policy_id

否

String

策略id，用于指定生成桌面名称策略。

id

否

String

批量操作磁盘的磁盘集合id。

type

是

String

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

• SAS：高IO。

• SSD：超高IO。

size

是

Integer

磁盘容量，单位GB。

resource_spec_code

否

String

规格

id

是

String

安全组ID。

object_type

是

String

绑定对象类型枚举。

• USER：用户

• USER_GROUP：用户组

object_id

是

String

用户/用户组id

object_name

是

String

用户/用户组名称

user_group

是

String

桌面用户所属的用户权限组。

• sudo：Linux管理员组。

• default：Linux默认用户组。

• administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。

• users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。

created_at

否

String

创建时间。格式为：UTC格式，例如“2022-05-11T11:45:42.000Z”。

key

是

String

标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

否

String

标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

autoscale_type

否

String

弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。

max_auto_created

否

Integer

自动创建桌面上限

min_idle

否

Integer

空闲桌面低于多少时开始自动创建桌面

once_auto_created

否

Integer

一次自动创建桌面的数量

job_id

String

创建云桌面总任务id

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

200

创建桌面池响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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