文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 用户/ 查询用户列表
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询用户列表

功能介绍

该接口用于查询桌面用户列表。

调试

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

URI

GET /v2/{project_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

user_name

否

String

桌面用户名，长度范围为1-20，不能包含特殊字符，不能以数字开头。

limit

否

String

用于分页查询，返回用户数量限制。如果不指定，则返回所有符合条件的用户。

offset

否

String

分页查询起始条数。

description

否

String

用户描述查询，模糊匹配。

active_type

否

String

激活类型，默认为用户激活。

  • USER_ACTIVATE： 用户激活

  • ADMIN_ACTIVATE： 管理员激活

group_name

否

String

桌面用户组名，精确匹配。

share_space_subscription

否

Boolean

用户是否已订阅协同，true/false

share_space_desktops

否

Boolean

用户是否已绑定协同桌面,true/false

is_query_total_desktops

否

Boolean

是否查询用户绑定的桌面数,true/false,默认true

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

用户总数。

users

Array of User objects

用户列表。
表5 User

参数

参数类型

描述

id

String

用户ID。

sid

String

用户ID。

user_name

String

桌面用户名。

user_email

String

用户邮箱。

total_desktops

Integer

用户绑定桌面云总数。

user_phone

String

手机号。

active_type

String

激活类型，默认为用户激活。

  • USER_ACTIVATE： 用户激活

  • ADMIN_ACTIVATE： 管理员激活

is_pre_user

Boolean

是不是预创建的用户。

account_expires

String

账户过期时间，0表示永远不过期。

password_never_expired

Boolean

密码是否永不过期，true表示密码永不过期，false表示密码会过期。

account_expired

Boolean

帐号是否过期，true表示已过期，false表示未过期。

enable_change_password

Boolean

是否允许修改密码，true表示允许，false表示不允许。

next_login_change_password

Boolean

下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。

description

String

用户描述。

locked

Boolean

账户是否被锁定，true表示被锁定，false表示未锁定。

disabled

Boolean

账户是否禁用，true表示被禁用，false表示未禁用。

share_space_subscription

Boolean

用户是否订阅协同，true表示已订阅，false表示未订阅

share_space_desktops

Integer

用户已绑定协同桌面数

group_names

Array of strings

加入的组列表。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

状态码： 503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

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

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users?limit=10

响应示例

状态码： 200

查询桌面云用户列表响应。

{
  "total_count" : 2,
  "users" : [ {
    "id" : "8a2c3f9579d240820179d51e6caf0001",
    "user_name" : "api-test",
    "user_email" : "test@huawei.com",
    "total_desktops" : 0,
    "account_expires" : "0",
    "enable_change_password" : true,
    "next_login_change_password" : true,
    "locked" : false,
    "disabled" : false
  }, {
    "id" : "8a2c3f9579d240820179d51e6caf0002",
    "user_name" : "api-test2",
    "user_email" : "test@huawei.com",
    "total_desktops" : 0,
    "account_expires" : "0",
    "enable_change_password" : true,
    "next_login_change_password" : true,
    "locked" : false,
    "disabled" : false
  } ]
}

状态码

状态码

描述

200

查询桌面云用户列表响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

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

503

服务不可用。

错误码

请参见错误码。

父主题： 用户

相关文档