FilterUsers分页
按用户属性筛选查询便捷账号信息
服务地址:
华东2(上海)
输入参数
只看必填
Filter模糊搜索字符串
PropertyFilterParam要模糊查询的用户属性列表
0要模糊查询的用户属性
PropertyId属性ID
PropertyValueIds属性值ID
PropertyKeyValueFilterParam属性名和属性值信息列表
0属性名和属性值信息
PropertyKey属性名
PropertyValues属性值
IncludeDesktopCount是否返回已分配给该用户的云电脑数量
请选择布尔值
IncludeDesktopGroupCount是否返回已分配给该用户的云电脑池数量
请选择布尔值
OrgId企业组织ID
OwnerType账号激活类型
ExcludeEndUserIds需精确排除的用户名(EndUserId)列表
0按用户名(EndUserId)精确排除
OrderParam支持的排序参数
OrderField按此参数排序
OrderType升序或降序
Status
IsQueryAllSubOrgs
请选择布尔值
IncludeOrgInfo
请选择布尔值
IncludeSupportIdps
请选择布尔值
分页参数
MaxResults分页查询时每页行数(大于100时会自动...
NextToken下一次查询的Token
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
MaxResultsinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10取值 <= 200
NextTokenstring

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

示例值:caeba0bbb2be03f84eb48b699f0a****
Filterstring

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

示例值:a*m
PropertyFilterParamarray<object>

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

子级条数 <= 100
PropertyKeyValueFilterParamarray<object>

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

子级条数 <= 100
IncludeDesktopCountboolean

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

示例值:true枚举值:truefalse
IncludeDesktopGroupCountboolean

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

示例值:false枚举值:truefalse
OrgIdstring

企业组织 ID。

示例值:org-aliyun-wy-org-id参考取值来源:
    CreateOrg
OwnerTypestring

账号激活类型。

示例值:Normal枚举值:CreateFromManagerNormal
ExcludeEndUserIdsarray<string>

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

子级条数 <= 2000
OrderParamobject

支持的排序参数。

Statusinteger<int32>
IsQueryAllSubOrgsboolean
IncludeOrgInfoboolean
IncludeSupportIdpsboolean

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextTokenstring

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

示例值:caeba0bbb2be03f84eb48b699f0a****
Usersarray<object>

便捷账号信息集合。

变更历史
变更时间变更内容概要操作
2025-03-24
新增请求参数IncludeOrgInfo
新增请求参数IncludeSupportIdps
变更返回参数
2024-12-11
新增请求参数IsQueryAllSubOrgs
2024-08-15
新增请求参数Status
2024-04-09
变更返回参数
2023-10-25
变更返回参数
2022-12-05
变更返回参数
2022-09-08
新增请求参数OrgId
新增请求参数OwnerType
新增请求参数ExcludeEndUserIds
新增请求参数OrderParam
变更返回参数
2021-08-10
新增OpenAPI,筛选查询便捷账号信息
  • 1
  • 2
  • 10 条/页