文档

FilterUsers - 筛选查询便捷账号信息

按用户属性筛选查询便捷账号信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
MaxResultslong

分页查询时每页行数(大于 100 时会自动重置为 100)。

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
Filterstring

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

a*m
PropertyFilterParamobject []

要模糊查询的用户属性列表。

PropertyIdlong

属性 ID。

328
PropertyValueIdsstring

属性值 ID。

1255
PropertyKeyValueFilterParamobject []

属性名和属性值信息列表。

PropertyKeystring

属性名。

job
PropertyValuesstring

属性值。

dev
IncludeDesktopCountboolean

是否返回已分配给该用户的云电脑数量。

枚举值:
  • true返回分配的云电脑数量
  • false不返回分配的云电脑数量
true
IncludeDesktopGroupCountboolean

是否返回已分配给该用户的云电脑池数量。

枚举值:
  • true返回分配的云电脑池数量
  • false不返回分配的云电脑池数量
false
OrgIdstring

企业组织 ID。

org-aliyun-wy-org-id
OwnerTypestring

账号激活类型。

枚举值:
  • CreateFromManager管理员激活
  • Normal用户激活
Normal
ExcludeEndUserIdsarray

需精确排除的用户名(EndUserId)列表。

string

按用户名(EndUserId)精确排除,查询不包含该用户名的用户列表。

tony
OrderParamobject

支持的排序参数。

OrderFieldstring

按此参数排序。

枚举值:
  • EndUserId用户名
  • id用户主键ID
  • gmt_created创建时间
id
OrderTypestring

升序或降序。

枚举值:
  • ASC升序
  • DESC降序 [默认值]
DESC

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

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

下一次查询的 Token。如果一次查询结果并没有完整返回所有的结果,则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。

caeba0bbb2be03f84eb48b699f0a****
Usersobject []

便捷账号信息集合。

Idlong

用户 ID。

4205**
EndUserIdstring

用户名。

alice
Emailstring

邮箱。

username@example.com
Phonestring

手机号。

1381111****
Statuslong

便捷账号的状态。

枚举值:
  • 0正常
  • 9锁定
0
UserSetPropertiesModelsobject []

用户属性集合。

UserIdlong

绑定属性的用户 ID。

4205**
UserNamestring

绑定属性的用户名。

alice
PropertyIdlong

用户属性 ID。

12
PropertyKeystring

用户属性名称。

department
PropertyTypeinteger

用户属性编号。

2
PropertyValuesobject []

用户属性值。

PropertyValueIdlong

用户属性值 ID。

42
PropertyValuestring

用户属性值。

dev
DesktopCountlong

分配给该用户的云电脑数量。

1
ExternalInfoobject

用户扩展信息。

ExternalNamestring

用户对接的账号名称。

account
JobNumberstring

用户对接的账号、学号或工号。

030801
DesktopGroupCountlong

用户拥有授权的云电脑池数量。当IncludeDesktopGroupCount取值为true时,返回该值。

2
OwnerTypestring

账号归属类型。

枚举值:
  • CreateFromManager管理员激活
  • Normal用户激活
Normal
Remarkstring

用户备注。

测试专用
IsTenantManagerboolean

是否租户管理员。

true
EnableAdminAccessboolean

是否本地管理员。

true
RealNickNamestring

用户昵称。

小明
AutoLockTimestring

自动锁定账号的日期。

2023-03-03
PasswordExpireDaysinteger

用户账号的密码默认为永久有效,可通过此参数设置 30~365 天的密码有效期,当密码到期后,终端用户必须先修改密码才能继续登录。

说明 该功能目前处于邀测中,如需体验,请提交工单申请开通。
30
PasswordExpireRestDaysinteger

账号密码有效期的剩余天数。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "UserSetPropertiesModels": [
        {
          "UserId": 0,
          "UserName": "alice",
          "PropertyId": 12,
          "PropertyKey": "department",
          "PropertyType": 2,
          "PropertyValues": [
            {
              "PropertyValueId": 42,
              "PropertyValue": "dev"
            }
          ]
        }
      ],
      "DesktopCount": 1,
      "ExternalInfo": {
        "ExternalName": "account",
        "JobNumber": "030801"
      },
      "DesktopGroupCount": 2,
      "OwnerType": "Normal",
      "Remark": "测试专用",
      "IsTenantManager": true,
      "EnableAdminAccess": true,
      "RealNickName": "小明",
      "AutoLockTime": "2023-03-03",
      "PasswordExpireDays": 30,
      "PasswordExpireRestDays": 10
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-10OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:IncludeDesktopGroupCount
出参OpenAPI 返回结构发生变更
2021-08-10OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PropertyKeyValueFilterParam