Query User Information on Pages

Last Updated on : 2023-06-20 15:19:02download

Query the information about users on pages.

API address

GET: /v1.0/iot-02/users

Request parameter

Parameter name	Type	IN	Required	Description
last_row_key	String	query	false	The row key of the last entry on each page.
page_size	Integer	query	true	The number of items to be returned per page.

Return parameter

Parameter name	Type	Description
result	QueryMerUsersResponse	The returned result.

Description of result

Parameter name	Type	Description
list	List	The returned list of users.
last_row_key	String	The row key of the last entry on each page.
page_size	Integer	The number of items to be returned per page.
has_next	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
user_name	String	The username.
country_code	String	The country code.
user_id	String	The user ID.
create_time	Long	The time when it is created.
user_nick_name	String	The nickname of a specified user.
account_type	Integer	The account type.
tenant_code	String	The code of a specified tenant.

Request example

GET: /v1.0/iot-02/users?last_row_key=&page_size=20

Return example

{
    "result": {
        "last_row_key": "1480****1472",
        "list": [
            {
                "create_time": 1641796814109,
                "user_name": "rootSfWZ",
                "user_nick_name": "",
                "country_code": "86",
                "user_id": "bay1****lSus",
                "tenant_code": "aym0****1426"
            },
            {
                "create_time": 1641796814496,
                "user_name": "userFgMU",
                "user_nick_name": "abc",
                "country_code": "86",
                "user_id": "bay1****O7eE",
                "tenant_code": "aym0****1426"
            }
        ],
        "has_next": false,
        "page_size": 10
    },
    "t": 1641796817618,
    "success": true
}

Error code

For more information, see error code.