文档首页/云桌面 Workspace/API参考/云桌面API/桌面池/查询桌面池详情 - ShowDesktopPoolDetail
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

查询桌面池详情 - ShowDesktopPoolDetail

功能介绍

指定桌面池Id查询详细信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/desktop-pools/{pool_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

pool_id

是

String

桌面池ID。

请求参数

无

响应参数

状态码：200

表2 响应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（已废弃，多个仅取第一个）。

subnet_ids

Array of strings

桌面池子网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 SecurityGroupInfo 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，用于指定生成桌面名称策略。

tags

Array of Tag objects

标签列表

ou_name

String

OU名称

vpc_id

String

VPC ID。

表3 ProductInfo

参数

参数类型

描述

product_id

String

产品ID。

flavor_id

String

产品规格ID。

type

String

产品类型。

  • BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。

cpu

String

CPU。

memory

String

内存。

descriptions

String

产品描述。

charge_mode

String

周期套餐标识，0表示包周期，1表示按需。

architecture

String

产品架构。

is_gpu

Boolean

是否是GPU类型的规格。

package_type

String

套餐类型。

  • ultimate：尊享版

  • enterprise：企业版

  • general: 通用办公版

  • workstation: 云工作站

  • dedicated: 专属办公版

  • solver: 解算版

  • agile: 敏捷办公版

system_disk_type

String

系统盘类型。

system_disk_size

String

系统盘大小。

contain_data_disk

Boolean

套餐计费是否包含了数据盘,off-不包含。

resource_type

String

资源类型。

cloud_service_type

String

云服务类型。

volume_product_type

String

磁盘产品类型。

status

String

默认在售状态，normal代表正常，sellout代表售空，abandon代表下线。

表4 VolumeInfo

参数

参数类型

描述

id

String

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

type

String

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

  • SAS：高IO。

  • SSD：超高IO。

size

Integer

磁盘容量，单位GB。

iops

Integer

iops，云硬盘每秒进行读写的操作次数。

throughput

Integer

吞吐量，云硬盘每秒成功传送的数据量，即读取和写入的数据量。

resource_spec_code

String

规格。

kms_id

String

kms密钥Id

表5 SecurityGroupInfo

参数

参数类型

描述

id

String

安全组ID。

name

String

安全组名称。

表6 AutoscalePolicy

参数

参数类型

描述

autoscale_type

String

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

max_auto_created

Integer

最大自动创建桌面数。

min_idle

Integer

预留空闲桌面数。

once_auto_created

Integer

一次自动创建桌面的数量(已弃用)。

min_retention

Integer

最小桌面数。

idle_retention_duration

Integer

空闲桌面保留时长（分钟）。

表7 Tag

参数

参数类型

描述

key

String

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

value

String

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

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338

响应示例

状态码：200

正常。

{
  "id" : "1ad74b36-0de7-45fe-aed3-6cb047d69e99",
  "name" : "yay-test",
  "type" : "STATIC",
  "description" : "",
  "created_time" : "2025-05-22T09:48:47Z",
  "charging_mode" : "1",
  "desktop_count" : 10,
  "desktop_used" : 5,
  "on_demand_desktop_num" : 0,
  "availability_zone" : "cn-north-7c",
  "subnet_id" : "7bf986f4-5ccf-87ko-93a4-1b1089ed53c3",
  "subnet_ids" : [ "7bf986f4-5ccf-87ko-93a4-1b1089ed53c3", "1dfda99e-115b-973f-af0c-e1ae9b82106f" ],
  "product" : {
    "product_id" : "workspace.x86.ultimate.large2",
    "flavor_id" : "c7.large.2",
    "type" : "BASE",
    "cpu" : "2",
    "memory" : "4096",
    "descriptions" : "尊享办公|2核|4GB内存",
    "charge_mode" : "1",
    "architecture" : "x86",
    "package_type" : "ultimate",
    "system_disk_type" : "SAS",
    "system_disk_size" : "140",
    "contain_data_disk" : false,
    "resource_type" : "hws.resource.type.workspace.desktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "volume_product_type" : "workspace",
    "status" : "normal"
  },
  "image_id" : "cc3bbc0b-9441-461b-b80b-48c52f3aed08",
  "image_name" : "WKS_WIN1064_UserImage",
  "image_os_type" : "Windows",
  "image_os_version" : "Windows 10 64bit",
  "image_os_platform" : "Windows",
  "root_volume" : {
    "id" : "651d3724-fa85-420a-ab5f-ff531629747f",
    "type" : "SAS",
    "size" : 80
  },
  "data_volumes" : [ {
    "id" : "305d3c76-199f-4407-8d82-2a42d970595e",
    "type" : "SAS",
    "size" : 10
  }, {
    "id" : "9969022b-557d-4c1e-b22f-e7736ebe30af",
    "type" : "SAS",
    "size" : 10
  } ],
  "security_groups" : [ ],
  "disconnected_retention_period" : 0,
  "enable_autoscale" : true,
  "autoscale_policy" : {
    "autoscale_type" : "AUTO_CREATED",
    "max_auto_created" : 1,
    "min_idle" : 10,
    "once_auto_created" : 1
  },
  "status" : "STEADY",
  "enterprise_project_id" : "0",
  "in_maintenance_mode" : false,
  "desktop_name_policy_id" : "TEST",
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "vpc_id" : "string",
  "ou_name" : "string"
}

状态码

状态码

描述

200

正常。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题：桌面池