云桌面 WORKSPACE-查询桌面池详情:响应参数

时间：2024-12-27 15:06:33

云桌面 WORKSPACE

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
id	String	桌面池ID。
name	String	桌面池名称。
type	String	桌面池类型。DYNAMIC：动态池，STATIC：静态池。
description	String	桌面池描述。
created_time	String	创建时间，格式为：UTC格式，例如“2022-05-11T11:45:42.000Z”。
charging_mode	String	计费模式，0：包周期，1：按需。
desktop_count	Integer	桌面池总桌面数量。
desktop_used	Integer	桌面池绑定用户的桌面个数。
availability_zone	String	可用区。
subnet_id	String	子网ID。
product	ProductInfo object	产品信息。
image_id	String	镜像ID。
image_name	String	镜像名称。
image_os_type	String	镜像OS类型。
image_os_version	String	镜像OS版本。
image_os_platform	String	镜像OS平台。
image_product_code	String	镜像的productCode（specCode）。
root_volume	VolumeInfo object	系统盘。
data_volumes	Array of VolumeInfo objects	数据盘列表。
security_groups	Array of SecurityGroup objects	桌面安全组。
disconnected_retention_period	Integer	动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。
enable_autoscale	Boolean	桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。
autoscale_policy	AutoscalePolicy object	弹性伸缩策略。
status	String	桌面池状态。 STEADY：稳态 TEMPORARY：临时态 EXIST_FROZEN：存在冻结桌面 UNKNOWN：未知态
enterprise_project_id	String	企业项目ID。
in_maintenance_mode	Boolean	桌面池是否处于管理员维护模式。
desktop_name_policy_id	String	策略id，用于指定生成桌面名称策略。

表4 ProductInfo
参数	参数类型	描述
product_id	String	产品ID。
flavor_id	String	产品规格ID。
type	String	产品类型。 BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。
cpu	String	CPU。
memory	String	内存。
descriptions	String	产品描述。
charge_mode	String	周期套餐标识，0表示包周期，1表示按需。

表5 VolumeInfo
参数	参数类型	描述
id	String	批量操作磁盘的磁盘集合id。
type	String	桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。
size	Integer	磁盘容量，单位GB。
resource_spec_code	String	规格。

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

表7 AutoscalePolicy
参数	参数类型	描述
autoscale_type	String	弹性伸缩类型，AC CES S_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。
max_auto_created	Integer	自动创建桌面上限。
min_idle	Integer	空闲桌面低于多少时开始自动创建桌面。
once_auto_created	Integer	一次自动创建桌面的数量。

状态码： 400

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

状态码： 401

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

状态码： 403

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

状态码： 404

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

状态码： 500

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