文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面池/ 查询桌面池授权的用户、用户组
更新时间：2025-07-09 GMT+08:00
查看PDF
分享

查询桌面池授权的用户、用户组

功能介绍

该接口用于查询指定桌面池授权的用户、用户组。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

pool_id

是

String

桌面池ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

objects

Array of AuthorizedObjects objects

授权对象。

total_count

Integer

满足条件的用户、用户组总数。
表5 AuthorizedObjects

参数

参数类型

描述

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”。

状态码：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接口进行解密。

请求示例

/v2/bcae3e673fd04716a3b9dacdf58ca336/desktop-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/users

响应示例

状态码：200

查询桌面池授权的用户、用户组响应。

{
  "objects" : [ {
    "object_type" : "USER",
    "object_id" : "object_id",
    "object_name" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
    "user_group" : "administrators",
    "created_at" : "2022-05-11T11:45:42.000Z"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

查询桌面池授权的用户、用户组响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

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

错误码

请参见错误码。

父主题： 桌面池