调用DescribeUsers查询便捷用户信息_无影云应用(App Streaming)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
MaxResults	long	否	分页查询时每页行数。取值范围：1~500。默认值：500。	10
NextToken	string	否	下一次查询的 Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果，则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。	caeba0bbb2be03f84eb48b699f0a****
Filter	string	否	模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（），例如将该字段设为`am`，则返回用户名或邮箱以`a`开头、以`m`结尾的所有结果。	a*m
EndUserIds	array	否	需精确匹配的用户名（EndUserId）列表。
	string	否	按用户名（EndUserId）精确匹配，查询用户名一致的账号信息。	alice
ExcludeEndUserIds	array	否	需精确排除的用户名（EndUserId）列表。
	string	否	按用户名（EndUserId）精确排除，查询不包含该用户名的账号列表。	tony
OrgId	string	否	按组织 ID 精确匹配，查询归属该组织的账号列表。	org-4mdgc1cocc59z****
GroupId	string	否	按用户组 ID 精确匹配，查询归属该用户组的账号列表。	ug-12341234****

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	下一次查询的 Token。NextToken 为空表示没有下一次。	caeba0bbb2be03f84eb48b699f0a4883
Users	array<object>	便捷账号信息集合。
	object	便捷账号信息集合。
Id	long	便捷账号 ID。	4205**
EndUserId	string	用户名。	alice
Email	string	邮箱。	username@example.com
Phone	string	手机号，如未设置该参数则不返回该参数。	1381111****
Status	long	状态。枚举值： 0：正常。 9：锁定。	0
OwnerType	string	便捷账号类型，包括：管理员激活类型，管理员设置用户名及用户密码，重置密码等用户通知将发送到管理员的邮箱或手机。用户激活类型，管理员设置用户名及用户接收通知的邮件或手机，云桌面开通通知（含初始密码）等用户通知将发送到用户的邮件或手机。	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
Avatar	string	用户头像 URL。	https://cdn.*****
Address	string	用户工作地址。	杭州市***
NickName	string	用户昵称。	李**
JobNumber	string	用户工号。	A10000**

示例

正常返回示例

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"
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "NickName": "李**",
      "RealNickName": "",
      "JobNumber": "A10000**"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-24	OpenAPI 入参发生变更	查看变更详情
2023-12-11	OpenAPI 入参发生变更	查看变更详情
2023-09-24	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-06	OpenAPI 返回结构发生变更	查看变更详情
2021-04-02	新增 OpenAPI	查看变更详情