调用FilterUsers按用户属性筛选查询便捷用户信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String FilterUsers

系统规定参数。取值:FilterUsers。

MaxResults Long 10

分页查询时每页行数。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

Filter String test

模糊搜索字符串,支持匹配用户名和邮箱。

IncludeDesktopCount Boolean true

是否返回已分配给该用户的云桌面信息。

PropertyFilterParam.N.PropertyId Long 123

用户属性编号。

PropertyFilterParam.N.PropertyValueIds String test

用户属性值编号。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

RequestId String DBD276B5-00FF-5E04-8EF7-5CBA09BF112A

请求ID。

Users Array of data

便捷用户信息集合。

DesktopCount Long 1

分配给该用户的云桌面数量。

Email String testName@example.com

邮箱。

EndUserId String testName

用户名。

Id Long 12345

用户ID。

Phone String 1871234****

手机号。

Status Long 0

用户状态。可能值:

  • 0:正常。
  • 9:锁定。
UserSetPropertiesModels Array of userSetPropertiesModels

用户属性集合。

PropertyId Long 12

用户属性ID。

PropertyKey String department

用户属性名称。

PropertyType Integer 2

用户属性编号。

PropertyValues Array of propertyValues

用户属性值。

PropertyValue String A

用户属性值。

PropertyValueId Long 42

用户属性值ID。

UserId Long 12345

绑定属性的用户ID。

UserName String testName

绑定属性的用户名。

示例

请求示例

https://eds-user.cn-shanghai.aliyuncs.com/?Action=FilterUsers
&<公共请求参数>

正常返回示例

XML格式

<FilterUsersResponse>
      <RequestId>DBD276B5-00FF-5E04-8EF7-5CBA09BF112A</RequestId>
      <Users>
            <Status>0</Status>
            <EndUserId>testName</EndUserId>
            <Email>testName@example.com</Email>
            <Phone></Phone>
            <Id>12345</Id>
            <UserSetPropertiesModels>
                  <PropertyValues>
                        <PropertyValueId>184</PropertyValueId>
                        <PropertyValue>true</PropertyValue>
                  </PropertyValues>
                  <UserId>12345</UserId>
                  <PropertyType>1</PropertyType>
                  <PropertyKey>enableAdminAccess</PropertyKey>
                  <PropertyId>145</PropertyId>
            </UserSetPropertiesModels>
            <UserSetPropertiesModels>
                  <PropertyValues>
                        <PropertyValueId>42</PropertyValueId>
                        <PropertyValue>A</PropertyValue>
                  </PropertyValues>
                  <UserId>12345</UserId>
                  <PropertyType>2</PropertyType>
                  <PropertyKey>department</PropertyKey>
                  <PropertyId>30</PropertyId>
            </UserSetPropertiesModels>
      </Users>
</FilterUsersResponse>

JSON格式

{
    "RequestId": "DBD276B5-00FF-5E04-8EF7-5CBA09BF112A",
    "Users": [
        {
            "Status": 0,
            "EndUserId": "testName",
            "Email": "testName@example.com",
            "Phone": "",
            "Id": 12345,
            "UserSetPropertiesModels": [
                {
                    "PropertyValues": [
                        {
                            "PropertyValueId": 184,
                            "PropertyValue": "true"
                        }
                    ],
                    "UserId": 12345,
                    "PropertyType": 1,
                    "PropertyKey": "enableAdminAccess",
                    "PropertyId": 145
                },
                {
                    "PropertyValues": [
                        {
                            "PropertyValueId": 42,
                            "PropertyValue": "A"
                        }
                    ],
                    "UserId": 12345,
                    "PropertyType": 2,
                    "PropertyKey": "department",
                    "PropertyId": 30
                }
            ]
        }
    ]
}