文档首页/云桌面 Workspace/API参考/云桌面API/桌面池/查询用户所关联的桌面池列表 - ListDesktopPoolsByUsers
更新时间：2026-02-10 GMT+08:00
查看PDF
分享

查询用户所关联的桌面池列表 - ListDesktopPoolsByUsers

功能介绍

该接口用于查询用户所关联的桌面池列表

调试

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

授权信息

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

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

URI

GET /v2/{project_id}/desktop-pools/statistics/by-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

user_ids

否

Array of strings

待查询的用户id列表

offset

否

Integer

用于分页查询，查询的起始记录序号，从0开始。

limit

否

Integer

用于分页查询，返回桌面数量限制。取值范围0-10，默认值是10。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

users

Array of ShowDesktopPoolListByUsersInfo objects

用户列表。

表4 ShowDesktopPoolListByUsersInfo

参数

参数类型

描述

user_id

String

用户id

desktop_pool_count

Integer

桌面池数

desktop_pools

Array of AttachDesktopPoolsInfo objects

运行状态统计

表5 AttachDesktopPoolsInfo

参数

参数类型

描述

desktop_pool_id

String

桌面池id

desktop_pool_name

String

桌面池名称

is_attached

Boolean

是否分配了桌面

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：409

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/statistics/by-users

响应示例

状态码：200

查询用户所关联的桌面池列表。

{
  "users" : [ {
    "user_id" : "user_id",
    "desktop_pools" : [ {
      "desktop_pool_id" : "1ad74b36-0de7-45fe-aed3-6cb047d69e99",
      "desktop_pool_name" : "yay-test",
      "is_attached" : false
    } ]
  } ]
}

状态码

状态码

描述

200

查询用户所关联的桌面池列表。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

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

错误码

请参见错误码。

父主题：桌面池