文档中心

云原生消息引擎

MQTT公共API

DescribeMQTTClients - 查询 EMQX 客户端连接信息列表

调用 DescribeMQTTClients 接口，查询 EMQX 客户端连接信息列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeMQTTClients

要执行的操作，取值：DescribeMQTTClients。

Version string 必选示例值：2024-09-01

API的版本，取值：2024-09-01。

InstanceId string 必选示例值：mqtt-0040****mfk6

MQTT 实例 ID。

PageNumber integer 可选示例值：1

列表的页码。

PageSize integer 可选示例值：100

列表大小。

ConnectionState string 可选示例值：pass

客户端连接状态。

ClientIdSpecifyList string[] 可选示例值：["Client-718"]

根据指定客户端 ID 查询。

ClientIdLike string 可选示例值：Client-718

根据客户端 ID 匹配查询。

UserNameSpecifyList string[] 可选示例值：/

根据用户名匹配。

UserNameLike string 可选示例值：/

根据用户名模糊查询。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mqtt-0040****mfk6

MQTT 实例 ID。

Total integer 示例值：1000

符合条件的总条数。

PageNumber integer 示例值：1

列表的页码。

PageSize integer 示例值：100

列表大小。

ClientsInfo object[] 示例值：/

客户端详情。

ClientId string 示例值：client-001

客户端 ID。

UserName string 示例值：testuser

连接客户端用户名。

ConnectionState string 示例值：pass

客户端连接状态。

IpAddress string 示例值：10.98.65.43

客户端连接 IP。

Port string 示例值：19867

客户端连接端口。

HeartBeatInterval string 示例值：30

心跳间隔超时时间（秒）。

SessionExpireInterval string 示例值：60

会话过期时间（秒）。

ConnectedTime string 示例值：2025-05-29T09:50:59.251+00:00

连接时间（格式化标准：RFC2822）。

DisconnectedTime string 示例值：2025-05-29T09:57:59.341+00:00

断连时间（格式化标准：RFC2822）。

SubscriptionsCount string 示例值：1

客户端订阅数。

请求示例

POST /?Action=DescribeMQTTClients&Version=2024-09-01 HTTP/1.1​
Host: bmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260211T090559Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260211/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "mqtt-0040****mfk6"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260212104417233081226*****",​
    "Action": "DescribeMQTTClients",​
    "Version": "2024-09-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "InstanceId": "mqtt-0040****mfk6",​
    "Total": 1000,​
    "PageNumber": 1,​
    "PageSize": 100,​
    "ClientsInfo": [​
      {​
        "ClientId": "client-001",​
        "UserName": "testuser",​
        "ConnectionState": "pass",​
        "IpAddress": "10.98.65.43",​
        "Port": "19867",​
        "HeartBeatInterval": "30",​
        "SessionExpireInterval": "60",​
        "ConnectedTime": "2025-05-29T09:50:59.251+00:00",​
        "DisconnectedTime": "2025-05-29T09:57:59.341+00:00",​
        "SubscriptionsCount": "1"​
      }​
    ]​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。

最近更新时间：2026.02.12 10:51:18

这个页面对您有帮助吗？

有用

无用