QueryMqttTraceMessageSubscribe_微消息队列 MQTT_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为600/60(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
MqttRegionIdstring

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

示例值:cn-hangzhou
InstanceIdstring

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

示例值:mqtt-cn-i7m26mf****参考取值来源:
    ListInstances
Reverseboolean

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

示例值:false
ClientIdstring

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

示例值:GID_test@@@consumer参考取值来源:
    ListDeviceCredentialClientId
BeginTimeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1621936800000取值 <= 9223372036854774807
EndTimeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1618646400000取值 <= 9223372036854774807
CurrentPageinteger<int32>

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

示例值:1取值 <= 2147483647
PageSizeinteger<int32>

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

示例值:5取值 <= 2147483647
MsgIdstring

消息 ID,即 Message ID。

示例值:AC1EC1B33D5978308DB17F3245E4****字符长度 <= 2147483647字符长度 >= 0

返回参数

字段名称字段详情
CurrentPageinteger<int32>

当前位于第几页。

示例值:1
RequestIdstring

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

示例值:4E685844-ADAF-4D85-9EAC-F9471E8C****
PageSizeinteger<int32>

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

示例值:5
Totalinteger<int64>

查询到的消息轨迹总数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:2
MessageTraceListsarray<object>

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

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
MqttOwnerCheckError
Failed to validate the instance permission诊断
404
ApiNotSupport
The specified API is not supported.诊断
500
SystemOverFlow
An error occurred while processing your request. Please try again.诊断

变更历史

变更时间变更内容概要操作
2025-02-10
新增错误码400
2024-03-20
变更请求参数MsgId

相关示例