1. 接口描述
接口请求域名： trocket.tencentcloudapi.com 。
查询 MQTT 客户端详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMQTTClient。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：rocketmq-xxxx |
| ClientId | 是 | String | 客户端详情 示例值：client1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端唯一标识 示例值：myclient001 |
| ClientAddress | String | 客户端网络地址 示例值：127.0.0.1:10001 |
| ProtocolVersion | Integer | MQTT 协议版本，4 表示 MQTT 3.1.1 示例值：4 |
| Keepalive | Integer | 保持连接时间，单位：秒 示例值：60 |
| ConnectionStatus | String | 连接状态，CONNECTED 已连接，DISCONNECTED 未连接 示例值：CONNECTED |
| CreateTime | Integer | 客户端创建时间 示例值：1701396000000 |
| ConnectTime | Integer | 上次建立连接时间 示例值：1701396000000 |
| DisconnectTime | Integer | 上次断开连接时间，仅对持久会话（cleanSession=false）并且客户端当前未连接时有意义 示例值：1701403200000 |
| MQTTClientSubscriptions | Array of MQTTClientSubscription | 客户端的订阅列表 示例值：[ { "Qos": 1, "TopicFilter": "home/sun/+/" }, { "Qos": 1, "TopicFilter": "home/temp/+/" }, { "Qos": 0, "TopicFilter": "home/humidity/+/" }, { "Qos": 2, "TopicFilter": "home/person/+/" } ] |
| Inbound | StatisticsReport | 服务端到客户端的流量统计 示例值： { "Bytes": 16, "PacketQos0": 4, "PacketQos1": 0, "PacketQos2": 0, "PacketTotal": 4 } |
| OutBound | StatisticsReport | 客户端到服务端的流量统计 示例值： { "Bytes": 16, "PacketQos0": 4, "PacketQos1": 0, "PacketQos2": 0, "PacketTotal": 4 } |
| CleanSession | Boolean | cleansession标志 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 样例
样例
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTClient
<公共请求参数>
{
"InstanceId": "mqtt-2vnk55xv",
"ClientId": "sub_client2"
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"CleanSession": true,
"ClientAddress": "11.176.16.153:23354",
"ClientId": "sub_client2",
"ConnectTime": 1711444795304,
"ConnectionStatus": "CONNECTED",
"CreateTime": 1711443908331,
"DisconnectTime": 0,
"Inbound": {
"Bytes": 40,
"Items": [
{
"Count": 1,
"MessageType": "SUBACK",
"Qos": 0
},
{
"Count": 1,
"MessageType": "CONNACK",
"Qos": 0
},
{
"Count": 14,
"MessageType": "PINGRESP",
"Qos": 0
}
]
},
"Keepalive": 60,
"MQTTClientSubscriptions": [
{
"Qos": 1,
"TopicFilter": "home/sun/+/"
},
{
"Qos": 1,
"TopicFilter": "home/temp/+/"
},
{
"Qos": 0,
"TopicFilter": "home/humidity/+/"
},
{
"Qos": 2,
"TopicFilter": "home/person/+/"
}
],
"OutBound": {
"Bytes": 134,
"Items": [
{
"Count": 1,
"MessageType": "CONNECT",
"Qos": 0
},
{
"Count": 1,
"MessageType": "SUBSCRIBE",
"Qos": 1
},
{
"Count": 14,
"MessageType": "PINGREQ",
"Qos": 0
}
]
},
"ProtocolVersion": 4,
"RequestId": "b59aa63c-6cc6-418a-92c7-c205cb30d4cd"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.Client | 客户端不存在。 |