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

查询用户详情信息 - ListUserDetail

功能介绍

该接口用于查询指定的桌面用户详情。

调试

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

授权信息

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

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

URI

GET /v2/{project_id}/users/{user_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

user_id

是

String

用户ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

user_detail

UserDetail object

用户详情。

表3 UserDetail

参数

参数类型

描述

description

String

用户描述。

id

String

用户id。

user_name

String

桌面用户名。

user_email

String

用户邮箱。

user_phone

String

手机号。

active_type

String

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

  • USER_ACTIVATE： 用户激活

  • ADMIN_ACTIVATE： 管理员激活

object_sid

String

用户sid。

sam_account_name

String

登录名(windows以前版本)。

user_principal_name

String

用户登录名。

full_name

String

全名。

distinguished_name

String

用户在域树上的唯一位置。

account_type

Integer

账号类型(0：用户；1：用户组)。

when_created

String

UTC时间毫秒数对应的字符，格式为：yyyy-MM-ddTHH:mm:ss.SSSZ。

account_expires

Long

账号有效期最后一天对应的UTC时间，以毫秒为单位。

is_pre_user

Boolean

是否是预创建的用户，true表示是预创建用户，false表示不是预创建用户。

user_expired

Boolean

账户是否过期，true表示过期，false表示未过期。

locked

Boolean

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

enable_change_password

Boolean

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

password_never_expired

Boolean

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

next_login_change_password

Boolean

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

disabled

Boolean

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

group_names

Array of strings

加入的组列表。

share_space_subscription

Boolean

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

share_space_desktops

Integer

用户已绑定协同桌面数。

total_desktops

Integer

用户绑定桌面云总数。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：405

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：503

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001

null

响应示例

状态码：200

查询桌面用户详细信息响应。

{
  "user_detail" : {
    "description" : "api测试用户。",
    "id" : "8a2c3f9579d240820179d51e6caf0001",
    "user_name" : "api-test",
    "user_email" : "test@huawei.com",
    "object_sid" : "8a2c3f9579d240820179d51e6caf0001",
    "sam_account_name" : "api-test",
    "full_name" : "api-test",
    "distinguished_name" : "api-test",
    "account_type" : 0,
    "when_created" : "2021-06-03T19:43:31.000Z",
    "account_expires" : 0,
    "user_expired" : false,
    "locked" : false,
    "enable_change_password" : true,
    "password_never_expired" : false,
    "next_login_change_password" : true,
    "disabled" : false,
    "group_names" : [ "DomainUsers" ],
    "total_desktops" : 0
  }
}

状态码

状态码

描述

200

查询桌面用户详细信息响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

500

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

503

服务不可用。

错误码

请参见错误码。

父主题：用户