云桌面 WORKSPACE-创建服务器组:请求参数

时间：2024-09-05 16:31:34

云桌面 WORKSPACE

请求参数

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

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	服务器组名称，名称需满足如下规则: 由中文，英文大小写，数字，_-组成，不能有空格。长度范围1~64个字符。
image_id	是	String	服务器组关联的镜像ID，用于创建对应组下的云服务器。
image_product_id	否	String	服务器组的镜像产品ID，当镜像为云市场镜像时，该字段必填。
image_type	是	String	镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他
os_type	是	String	系统类型，当前仅支持Windows。 Linux - Windows - Other -
description	否	String	服务器组描述。
route_policy	否	RoutePolicy object	路由策略。
product_id	是	String	产品ID。说明：获取方式详见产品套餐管理ListProduct："GET /v1/{project_id}/product"。
flavor_id	否	String	规格ID。
vpc_id	是	String	虚拟私有云ID。
subnet_id	是	String	网卡对应的子网ID。
system_disk_type	是	String	磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO
system_disk_size	是	Integer	磁盘容量，单位GB。
ou_name	否	String	默认组织名称。
cluster_id	否	String	云服务器系统盘对应的存储池的ID。
availability_zone	否	String	可用分区。说明：将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区。获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。
ip_virtual	否	IpVirtual object	虚拟IP功能选项。
is_vdi	否	Boolean	是否为vdi单会话模式。
app_type	否	String	服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app
extra_session_type	否	String	付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。
extra_session_size	否	Integer	付费会话数，单位/个。
tags	否	Array of TmsTag objects	标签信息，最多包含20个key,不允许重复
enterprise_project_id	否	String	企业项目ID,仅企业项目需配置(字段为空或者0表示使用默认default企业项目)
primary_server_group_id	否	String	主服务器组id,绑定主服务器组，则创建的是备服务器。
server_group_status	否	Boolean	是否启用服务器组。

表4 RoutePolicy
参数	是否必选	参数类型	描述
max_session	否	Integer	单台服务器最大的链接会话数。
cpu_threshold	否	Integer	cpu使用率阈值，单位为%。
mem_threshold	否	Integer	内存使用率阈值，单位为%。

表5 IpVirtual
参数	是否必选	参数类型	描述
enable	是	Boolean	是否启用虚拟IP功能。启用虚拟IP功能将占用额外的ip地址，注意合理规划网络ip数量。约束：只支持windows镜像。只支持在创建服务器组时设置功能开关，不支持更新功能开关。只支持具备dhcp动态分配ip能力的网络。

表6 TmsTag
参数	是否必选	参数类型	描述
key	是	String	键。最大长度128个unicode字符。可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。两头不能有空白字符。
value	否	String	值。每个值最大长度255个unicode字符。可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。