1. 接口描述
接口请求域名: trocket.tencentcloudapi.com 。
查询MQTT消息详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMQTTMessage。 |
Version | 是 | String | 公共参数,本接口取值:2023-03-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:rocketmq-xxxx |
Topic | 是 | String | 主题 示例值:test |
MsgId | 是 | String | 消息ID 示例值:0B8D67D3003505C29BFD077EC65B0002 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Body | String | 消息体 示例值:body |
Properties | Array of CustomMapEntry | 详情参数 示例值:[ { "Key": "TRACE_ON", "Value": "true" }, { "Key": "originMqttTopic", "Value": "mqtt-mwmdg9dm%home/humidity/room0" }, { "Key": "INNER_MULTI_DISPATCH", "Value": "%LMQ%mqtt-mwmdg9dm%home%humidity%+%,%LMQ%mqtt-mwmdg9dm%home%humidity%room0%" }, { "Key": "IS_EMPTY_MSG", "Value": "false" }, { "Key": "INNER_MULTI_QUEUE_OFFSET", "Value": "30,40" }, { "Key": "retryTimes", "Value": "0" }, { "Key": "extData", "Value": "{"qosLevel":"2"}" }, { "Key": "MSG_REGION", "Value": "cd" }, { "Key": "qosLevel", "Value": "2" }, { "Key": "UNIQ_KEY", "Value": "0B8D67D3003505C29BFD077EC65B0002" }, { "Key": "CLUSTER", "Value": "rmqbk-mqtt" }, { "Key": "TAGS", "Value": "MQTT_COMMON" }, { "Key": "_CLIENTHOST", "Value": "11.176.16.153:26866" } ] |
ProduceTime | String | 生产时间 示例值:2024-04-02 10:55:48 |
MessageId | String | 消息ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:0B8D67D3003505C29BFD077EC65B0002 |
ProducerAddr | String | 生产者地址 示例值:127.0.0.1:8888 |
ShowTopicName | String | Topic 示例值:topic1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTMessage
<公共请求参数>
{
"InstanceId": "mqtt-47ka4rdr",
"Topic": "topic24",
"MsgId": "0B8D67F0002D6ACBCFC0557BCEBA0001"
}
输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Body": "Hello MQTT111111",
"MessageId": "0B8D67F0002D6ACBCFC0557BCEBA0001",
"ProduceTime": "2024-01-17 14:22:57",
"ProducerAddr": "11.176.16.153:51134",
"Properties": [
{
"Key": "TRACE_ON",
"Value": "true"
},
{
"Key": "originMqttTopic",
"Value": "mqtt-47ka4rdr%topic24/1"
},
{
"Key": "INNER_MULTI_DISPATCH",
"Value": "%LMQ%mqtt-47ka4rdr%topic24%1%"
},
{
"Key": "IS_EMPTY_MSG",
"Value": "false"
},
{
"Key": "INNER_MULTI_QUEUE_OFFSET",
"Value": "0"
},
{
"Key": "retryTimes",
"Value": "0"
},
{
"Key": "extData",
"Value": "{\"qosLevel\":\"1\"}"
},
{
"Key": "MSG_REGION",
"Value": "cd"
},
{
"Key": "qosLevel",
"Value": "1"
},
{
"Key": "UNIQ_KEY",
"Value": "0B8D67F0002D6ACBCFC0557BCEBA0001"
},
{
"Key": "CLUSTER",
"Value": "rmqbk-mqtt"
},
{
"Key": "TAGS",
"Value": "MQTT_COMMON"
},
{
"Key": "__CLIENT_HOST",
"Value": "11.176.16.153:51134"
}
],
"RequestId": "e658afc8-e2c0-463e-bf90-3103d881d59f",
"ShowTopicName": "topic24"
}
}
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.Instance | 实例不存在。 |
ResourceNotFound.Message | 消息不存在。 |