tencent cloud

DescribeClientList
Last updated:2026-01-13 21:49:34
DescribeClientList
Last updated: 2026-01-13 21:49:34

1. API Description

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

This API is used to query the MQTT client details.

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: DescribeClientList.
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 tencent cloud MQTT instance ID, obtained from the DescribeInstanceList api or console.
ClientId No String Client ID
Number No String Limit on the number of clients. Maximum value: 1024. Default value: 1024.

3. Output Parameters

Parameter Name Type Description
Clients Array of MQTTClientInfo Specifies the client 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: DescribeMQTTClientList
<Common request parameters>

{
    "InstanceId": "mqtt-2vnk55xv",
    "ClientId": "sub",
    "Number": "10"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Clients": [
            {
                "ClientAddress": "11.176.16.153:63066",
                "ClientId": "sub_client1",
                "ConnectTime": 1710314923557,
                "ConnectionStatus": "CONNECTED",
                "CreateTime": 1710314923554,
                "DisconnectTime": 0,
                "Keepalive": 60,
                "MQTTClientSubscriptions": [
                    {
                        "Qos": 1,
                        "TopicFilter": "home/temp/+/"
                    },
                    {
                        "Qos": 0,
                        "TopicFilter": "home/humidity/+/"
                    },
                    {
                        "Qos": 2,
                        "TopicFilter": "home/person/+/"
                    }
                ],
                "ProtocolVersion": 4
            },
            {
                "ClientAddress": "11.176.16.153:62048",
                "ClientId": "sub_client2",
                "ConnectTime": 1710314912143,
                "ConnectionStatus": "CONNECTED",
                "CreateTime": 1710314912140,
                "DisconnectTime": 0,
                "Keepalive": 60,
                "MQTTClientSubscriptions": [
                    {
                        "Qos": 1,
                        "TopicFilter": "home/sun/+/"
                    },
                    {
                        "Qos": 1,
                        "TopicFilter": "home/temp/+/"
                    },
                    {
                        "Qos": 0,
                        "TopicFilter": "home/humidity/+/"
                    },
                    {
                        "Qos": 2,
                        "TopicFilter": "home/person/+/"
                    }
                ],
                "ProtocolVersion": 4
            }
        ],
        "RequestId": "9f81924f-41e8-4f24-aaf2-61da7da9c713"
    }
}

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

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
No

Feedback