AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeUsers - 查询便捷账号信息

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询便捷账号信息，例如用户名、邮箱地址、备注名称等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeUsers

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
MaxResults

integer

否

分页查询时每页行数。

  • 取值范围：1~500。

  • 默认值：200。

10
NextToken

string

否

下一次查询的 Token。首次调用接口时无需设置该参数。
如果一次查询结果并没有完整返回所有的结果，则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。

caeba0bbb2be03f84eb48b699f0a****
Filter

string

否

模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（*），例如将该字段设为a*m，则返回用户名或邮箱以a开头、以m结尾的所有结果。

a*m
FilterMap

object

否

string

否

EndUserIds

array

否

需精确匹配的用户名（EndUserId）列表。

string

否

按用户名（EndUserId）精确匹配，查询用户名一致的账号信息。

alice
ExcludeEndUserIds

array

否

需精确排除的用户名（EndUserId）列表。

string

否

按用户名（EndUserId）精确排除，查询不包含该用户名的账号列表。

tony
OrgId

string

否

按组织 ID 精确匹配，查询归属该组织的账号列表。

org-4mdgc1cocc59z****
GroupId

string

否

按用户组 ID 精确匹配，查询归属该用户组的账号列表。

ug-12341234****
BizType

string

否

说明

该参数不对外开放使用。

null
SolutionId

string

否

说明

该参数不对外开放使用。

null
ShowExtras

object

否

查询用户扩展信息。

any

否

key 为以下类型，值为 Boolean 类型，传 true 表示查询指定的信息。其中归属用户组和部门默认返回。

  • Group: 归属的用户组。

  • Org: 归属的部门。

  • ResourcesCount: 已分配的资源个数。

  • Properties: 用户属性。

ResourcesCount: true
FilterWithAssignedResources

object

否

根据否分配云资源筛选用户。

boolean

否

key 为以下类型，值为 Boolean 类型，传 true 表示筛选分配该云资源的用户。

  • Desktop: 云电脑。

  • DesktopGroup: 共享型云电脑。

  • CloudDrive: 企业网盘（用户个人盘）。

  • App: 云应用。

DesktopGroup: true
IsQueryAllSubOrgs

boolean

否

是否查询子组织下的用户。

true
FilterWithAssignedResource

object

否

string

否

key 为以下类型，值为该云资源的 ID。

  • DesktopGroup: 共享型云电脑。

  • App: 云应用交付组。

App:aig-jfgmanbo****
Status

integer

否

状态

ExcludeGroupId

string

否

BusinessChannel

string

否

渠道

ENTERPRISE

返回参数

名称

类型

描述

示例值

object

返回信息集合。

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken

string

下一次查询的 Token。NextToken 为空表示没有下一次。

caeba0bbb2be03f84eb48b699f0a4883
Users

array<object>

便捷账号信息集合。

array<object>

便捷账号信息集合。

Id

integer

便捷账号 ID。

4205**
EndUserId

string

用户名。

alice
Email

string

邮箱。

username@example.com
Phone

string

手机号，如未设置该参数则不返回该参数。

1381111****
Status

integer

状态。

枚举值：

  • 0 :

    正常

  • 9 :

    锁定

0
OwnerType

string

便捷账号类型，包括：

  • 管理员激活类型，管理员设置用户名及用户密码，重置密码等用户通知将发送到管理员的邮箱或手机。

  • 用户激活类型，管理员设置用户名及用户接收通知的邮件或手机，云电脑开通通知（含初始密码）等用户通知将发送到用户的邮件或手机。

枚举值：

  • CreateFromManager :

    管理员激活

  • Normal :

    用户激活

Normal
Remark

string

便捷账号的备注。

Test user.
OrgId

string

便捷账号归属的部门 ID。

说明

该参数即将废弃。

org-4mdgc1cocc59z****
WyId

string

便捷账号的全局唯一 ID。

41fd1254d8f7****
IsTenantManager

boolean

是否为用户管理员。如果创建的便捷账号是管理员激活类型，则必须指定一位用户管理员，终端用户通过客户端重置密码等通知将发送到该用户管理员的邮箱或手机，详情参见创建便捷账号。

true
Groups

array<object>

便捷账号归属的用户组集合。

object

便捷账号归属的用户组属性。

GroupId

string

用户组 ID。

ug-12341234****
GroupName

string

用户组名称。

用户组1
Orgs

array<object>

便捷账号归属的部门集合。

object

便捷账号归属的部门属性。

OrgId

string

部门 ID。

org-4mdgc1cocc59z****
OrgName

string

部门名称。

部门1
OrgNamePath

string

Avatar

string

用户头像 URL。

https://cdn.*****
Address

string

用户工作地址。

杭州市***
NickName

string

用户昵称。
按以下顺序取值：

  • RealNickName

  • Remark

  • EndUserId

李**
RealNickName

string

用户显示名。

李**
JobNumber

string

用户工号。

A10000**
Extras

object

用户扩展信息。

AssignedResourceCount

object

已分配的云资源个数。

any

支持的云资源类型：

  • Desktop：云电脑。

  • DesktopGroup：共享型云电脑。

  • CloudDrive：企业网盘（用户个人盘）。

  • APP：云应用。

Desktop: 3
ResourcePolicyList

array<object>

object

PolicyId

string

PolicyName

string

ExternalName

string

外部导入的用户名称。

说明

该字段暂未对外开放使用。

马**
Properties

array<object>

用户属性。

object

属性列表。

Key

string

属性名。

Role
Value

string

属性值。

Student
EnableAdminAccess

boolean

启用管理员访问权限

PasswordExpireDays

integer

PasswordExpireRestDays

integer

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "Test user.",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "用户组1"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "部门1",
          "OrgNamePath": ""
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "NickName": "李**",
      "RealNickName": "李**",
      "JobNumber": "A10000**",
      "Extras": {
        "AssignedResourceCount": {
          "key": "Desktop: 3"
        },
        "ResourcePolicyList": [
          {
            "PolicyId": "",
            "PolicyName": ""
          }
        ]
      },
      "ExternalName": "马**",
      "Properties": [
        {
          "Key": "Role",
          "Value": "Student"
        }
      ],
      "EnableAdminAccess": true,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：UnlockUsers - 解锁便捷账号下一篇：FilterUsers - 筛选查询便捷账号信息