文档

QueryMqttTraceMessageSubscribe - 查询消息消费轨迹

更新时间:
一键部署

查询指定消息的投递轨迹。当消息的收发不符合预期时,您可以通过该接口查看订阅该消息的客户端、消息的投递时间等详细信息,帮助您快速定位异常原因。

接口说明

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

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
InstanceIdstring

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

mqtt-cn-i7m26mf****
Reverseboolean

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

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

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

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

false
ClientIdstring

指定订阅消息的客户端 ID。若不输入,则返回所有订阅该消息的客户端信息。

GID_test@@@consumer
BeginTimelong

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

1621936800000
EndTimelong

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

1618646400000
CurrentPageinteger

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

1
PageSizeinteger

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

5
MsgIdstring

消息 ID,即 Message ID。

AC1EC1B33D5978308DB17F3245E4****

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前位于第几页。

1
RequestIdstring

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

4E685844-ADAF-4D85-9EAC-F9471E8C****
PageSizeinteger

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

5
Totallong

查询到的消息轨迹总数。

2
MessageTraceListsobject []

返回的消息投递轨迹列表。

Timestring

消息的投递时间。

2021-05-25 16:46:41.274
Actionstring

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

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

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

sub
ActionCodestring

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

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

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

mqtt.trace.action.msg.sub
ActionInfostring

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

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

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

Push To Mqtt Client
MsgIdstring

消息 ID,即 Message ID。

AC1EC1B33D5978308DB17F3245E4****
ClientIdstring

订阅消息的客户端 ID。

GID_test@@@consumer

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "4E685844-ADAF-4D85-9EAC-F9471E8C****",
  "PageSize": 5,
  "Total": 2,
  "MessageTraceLists": [
    {
      "Time": "2021-05-25 16:46:41.274",
      "Action": "sub",
      "ActionCode": "mqtt.trace.action.msg.sub",
      "ActionInfo": "Push To Mqtt Client",
      "MsgId": "AC1EC1B33D5978308DB17F3245E4****",
      "ClientId": "GID_test@@@consumer"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。
500SystemOverFlowAn error occurred while processing your request. Please try again.系统限流,请重试。

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

变更历史

变更时间变更内容概要操作
2024-03-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
    删除错误码:500

控制台操作

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

  • 本页导读 (1)