QueryMqttTraceMessageOfClient - 查询消息轨迹

更新时间:2025-02-18 02:30:28

查询指定设备在一定时间段内的消息列表。当消息的收发不符合预期时,您可以通过该接口查看消息的收发状态等轨迹信息,帮助您快速定位异常原因。

接口说明

  • 每成功调用一次 QueryMqttTraceMessageOfClient 接口,都会计算为一次消息 TPS,从而影响您的计费。计费详情,请参见计费说明
  • 本接口的单用户 QPS 限制为 500 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
MqttRegionIdstring

云消息队列 MQTT 版实例地域(Region)的 ID。请参见服务接入点

cn-hangzhou
InstanceIdstring

云消息队列 MQTT 版实例的 ID,一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面的基础信息区域查看。

mqtt-cn-i7m26mf****
ClientIdstring

需要查询消息列表的设备的 Client ID。

GID_test@@@producer
BeginTimelong

查询范围的起始时间戳。单位:毫秒。

1618646400000
EndTimelong

查询范围的终止时间戳。单位:毫秒。

1621591200000
CurrentPageinteger

当前取第几页消息,从 1 开始递增。若输入参数大于总页数,则返回结果为空。

1
PageSizeinteger

分页查询,每页最多显示的消息数量,最小 1 条,最多 100 条。

5
Reverseboolean

返回结果是否倒序显示。取值说明如下:

  • true:按照消息发送或消费时间倒序显示,最后一条发送或消费的消息显示在第一条,最早一条发送或消费的消息显示在最后一条。

  • false:按照消息发送或消费时间顺序显示,最早一条发送或消费的消息显示在第一条,最后一条发送或消费的消息显示在最后一条。

若不输入,则返回结果默认按照消息发送或消费的时间顺序显示。

false

返回参数

名称类型描述示例值
名称类型描述示例值
object
CurrentPageinteger

当前位于第几页。

1
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

B096B9D6-62F3-4567-BB59-58D1362E****
PageSizeinteger

每页最多显示的消息数量。

10
Totallong

查询到的消息总数。

5
MessageOfClientListarray<object>

返回的消息列表。

MessageOfClientListobject
Timestring

消息发送的时间或被消费的时间。

2021-05-21 15:08:19.234
Actionstring

消息动作。取值说明如下:

  • pub_mqtt:微消息队列 MQTT 版客户端发送消息。

  • sub:微消息队列 MQTT 版客户端订阅消息。

  • push_offline:服务端推送离线消息到微消息队列 MQTT 版客户端。

pub_mqtt
ActionCodestring

消息动作的返回码。取值说明如下

  • mqtt.trace.action.msg.pub.mqtt:消息动作取值为pub_mqtt时返回该参数值。

  • mqtt.trace.action.msg.sub:消息动作取值为 sub 时返回该参数值。

  • mqtt.trace.action.msg.push.offline:消息动作取值为push_offline时返回该参数值。

mqtt.trace.action.msg.pub.mqtt
ActionInfostring

消息动作的返回信息。取值说明如下:

  • Pub From Mqtt Client:消息动作取值为pub_mqtt时返回该参数值。

  • Push To Mqtt Client:消息动作取值为 sub 时返回该参数值。

  • Push Offline Msg To Mqtt Client:消息动作取值为push_offline时返回该参数值。

Pub From Mqtt Client
MsgIdstring

消息 ID,即 Message ID。

AC1EC0030EAB78308DB16A3EC773****
ClientIdstring

设备的 Client ID。

GID_test@@@producer

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "B096B9D6-62F3-4567-BB59-58D1362E****",
  "PageSize": 10,
  "Total": 5,
  "MessageOfClientList": [
    {
      "Time": "2021-05-21 15:08:19.234",
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ActionInfo": "Pub From Mqtt Client",
      "MsgId": "AC1EC0030EAB78308DB16A3EC773****",
      "ClientId": "GID_test@@@producer"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400MqttOwnerCheckErrorFailed to validate the instance permission实例权限校验失败
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。
500SystemOverFlowAn error occurred while processing your request. Please try again.系统限流,请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2025-02-10OpenAPI 错误码发生变更查看变更详情

控制台操作

除了调用 QueryMqttTraceMessageOfClient 接口,您还可以通过微消息队列 MQTT 版控制台查看设备的消息列表。具体操作,请参见消息轨迹查询

  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
  • 控制台操作
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等