DescribeUserList

Last updated:2026-01-13 21:49:29

DescribeUserList

Last updated: 2026-01-13 21:49:29

1. API Description

Domain name for API request: mqtt.intl.tencentcloudapi.com.

This API is used to query the user list. Filter parameter usage instructions are as follows:.

This API is used to perform Username fuzzy search.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeUserList.
Version	Yes	String	Common Params. The value used for this API: 2024-05-16.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID, obtained from the DescribeInstanceList api or console.
Filters.N	No	Array of Filter	Specifies the supported fields in the query criteria list. Username: specifies the Username for filtering, supports fuzzy filtering. type: String.
Offset	No	Integer	Query start position. default value: 0.
Limit	No	Integer	Specifies the query result limit count. default value: 20. maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total query count
Data	Array of MQTTUserItem	Role information list
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

This example shows you the example.

Input Example

POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTUserList
<Common request parameters>

{
    "InstanceId": "mqtt-47ka4rdr",
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "CreatedTime": 1705392159000,
                "ModifiedTime": 1705392159000,
                "Password": "pwd1",
                "Remark": "remark",
                "Username": "user1"
            }
        ],
        "RequestId": "8e86117c-a56c-4598-9e1f-4a039eed6e3a",
        "TotalCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud