帮你快速理解、总结文档立即下载
文档中心>API 中心>消息队列 MQTT 版>集群相关接口>事件查询

事件查询

最近更新时间：2026-10-13 03:06:31
我的收藏

本页目录：

1. 接口描述

接口请求域名： mqtt.tencentcloudapi.com 。

查询轨迹

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClientEvents。
Version 是 String 公共参数，本接口取值：2024-05-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 集群id
示例值：mqtt-12345
StartTime 是 Integer 开始时间
示例值：1712025623202
EndTime 是 Integer 结束时间
示例值：1712025623202
ClientId 是 String 客户端id
示例值：client1

3. 输出参数

参数名称 类型 描述
Events Array of EventItem 轨迹
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEvent
<公共请求参数>

{
    "InstanceId": "mqtt-pjn3nqdm",
    "StartTime": 1729129907689,
    "EndTime": 1729133507689,
    "ClientId": "mqttx_chongfu"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Events": [
            {
                "ClientId": "mqttx_chongfu",
                "Event": "client.subscribed",
                "Info": [
                    {
                        "Key": "topic",
                        "Value": "home/#/"
                    },
                    {
                        "Key": "qos",
                        "Value": "2"
                    },
                    {
                        "Key": "username",
                        "Value": "sun"
                    }
                ],
                "Timestamp": 1729131546478
            },
            {
                "ClientId": "mqttx_chongfu",
                "Event": "client.disconnected",
                "Info": [
                    {
                        "Key": "reason",
                        "Value": "normal"
                    },
                    {
                        "Key": "disconnected_at",
                        "Value": "1729131555468"
                    }
                ],
                "Timestamp": 1729131555468
            },
            {
                "ClientId": "mqttx_chongfu",
                "Event": "client.connected",
                "Info": [
                    {
                        "Key": "topic",
                        "Value": null
                    },
                    {
                        "Key": "qos",
                        "Value": null
                    },
                    {
                        "Key": "username",
                        "Value": "sun"
                    }
                ],
                "Timestamp": 1729131532865
            },
            {
                "ClientId": "mqttx_chongfu",
                "Event": "client.unsubscribed",
                "Info": [
                    {
                        "Key": "topic",
                        "Value": "home/#/"
                    },
                    {
                        "Key": "qos",
                        "Value": "2"
                    },
                    {
                        "Key": "username",
                        "Value": "sun"
                    }
                ],
                "Timestamp": 1729131553007
            }
        ],
        "RequestId": "6c2727c8-c012-4385-ac01-da30e2a4dff8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
ResourceNotFound.Instance ResourceNotFound.Instance
中国站