按用户属性筛选查询便捷用户信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MaxResults | long | 否 | 分页查询时每页行数(大于 100 时会自动重置为 100)。 | 10 |
NextToken | string | 否 | 下一次查询的 Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果,则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。 | caeba0bbb2be03f84eb48b699f0a**** |
Filter | string | 否 | 模糊搜索字符串,支持匹配用户名(EndUserId)和邮箱(Email)。该字段支持使用通配符(*),例如将该字段设为 a*m,则返回用户名或邮箱以 a 开头、以 m 结尾的所有结果。 | a*m |
PropertyFilterParam | object [] | 否 | 要模糊查询的用户属性列表。 | |
PropertyId | long | 否 | 属性 ID。 | 328 |
PropertyValueIds | string | 否 | 属性值 ID。 | 1255 |
PropertyKeyValueFilterParam | object [] | 否 | 属性名和属性值信息列表。 | |
PropertyKey | string | 否 | 属性名。 | job |
PropertyValues | string | 否 | 属性值。 | dev |
IncludeDesktopCount | boolean | 否 | 是否返回已分配给该用户的云电脑数量。 枚举值:
| true |
IncludeDesktopGroupCount | boolean | 否 | 是否返回已分配给该用户的云电脑池数量。 枚举值:
| false |
OrgId | string | 否 | 企业组织 ID。 | org-aliyun-wy-org-id |
OwnerType | string | 否 | 账号归属类型。 枚举值:
| Normal |
ExcludeEndUserIds | array | 否 | 需精确排除的用户名(EndUserId)列表。 | |
string | 否 | 按用户名(EndUserId)精确排除,查询不包含该用户名的用户列表。 | tony | |
OrderParam | object | 否 | 支持的排序参数。 | |
OrderField | string | 否 | 按此参数排序。 枚举值:
| id |
OrderType | string | 否 | 升序或降序。 枚举值:
| DESC |
返回参数
示例
正常返回示例
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": "小明"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-10-25 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2021-08-10 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2021-08-10 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2021-08-10 | OpenAPI 入参发生变更 | 看变更集 | ||||||
|