根据 Topic 等信息查询历史消息收发量。

使用场景

OnsMqttQueryMsgTransTrend 接口一般用于生成数据报表、统计业务规模等场景。

使用限制

由于 OpenAPI 面向的场景是用户自定义管控开发,服务端会对过快的调用进行限流(每分钟 30 次),因此不要在业务的主流程中使用本接口。如需判断设备是否在线,请使用设备上下线通知功能,详情请参见获取 MQTT 客户端在线状态

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsMqttQueryMsgTransTrend

系统规定参数。取值:OnsMqttQueryMsgTransTrend。

BeginTime Long 1570957261

查询的起始时间。

EndTime Long 1570962601

查询的终止时间,起止时间范围建议尽可能在当天,否则后端会自动截断。

InstanceId String post-cn-0pp12gl****

需查询的消息所属的 MQTT 实例 ID。针对有独立命名空间的实例,该参数为必填。

ParentTopic String test

需查询的父 Topic。

TpsType String TPS

查询类别,取值说明如下:

  • TPS:消息生产 TPS
  • SUM:查询消息生产总量

其他值无效。

TransType String PUB

查询类别,取值说明如下:

  • PUB:查询消息生产报表
  • SUB:查询消息消费报表

其他值无效。

SubTopic String /testMq4Iot

需查询的子 Topic,如果没有子 Topic 或者需查询父 Topic 的所有信息,可为空。

MsgType String P2P

消息类别,取值说明如下:

  • P2P:点对点
  • SUB:发布/订阅

如果不填则默认查所有消息,其他值无效。

Qos Integer 0

查询的 QoS 级别,取值说明如下:

  • 0:最多分发一次
  • 1:至少达到一次
  • 2:仅分发一次

其他值或者不填都默认查所有消息。QoS 的详细信息,请参见名词解释

返回数据

名称 类型 示例值 描述
Data Struct

数据集合。

Records Array

采集点信息。

StatsDataDo
X Long 1570960800

横轴,毫秒时间戳。

Y Float 3

纵轴,数据(TPS 或者总量)。

Title String 消息生产TPS

Table 的名称。

XUnit String 时间

时间戳,单位毫秒。

YUnit String 条/秒

纵轴单位。

RequestId String 77B5727C-CCDF-4404-B7A0-EC0D3CF4BEDE

为公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsMqttQueryMsgTransTrend
&BeginTime=1570957261
&EndTime=1570962601
&ParentTopic=test
&TpsType=TPS
&TransType=PUB
&SubTopic=/testMq4Iot
&MsgType=P2P
&Qos=0
&InstanceId=post-cn-0pp12gl****
&<公共请求参数>

正常返回示例

XML 格式

<OnsMqttQueryMsgTransTrendResponse>
  <Data>
        <Records>
              <StatsDataDo>
                    <X>1570960800</X>
                    <Y>3</Y>
              </StatsDataDo>
        </Records>
        <XUnit>时间</XUnit>
        <YUnit>条/秒</YUnit>
        <Title>消息生产TPS</Title>
  </Data>
  <RequestId>77B5727C-CCDF-4404-B7A0-EC0D3CF4BEDE</RequestId>
</OnsMqttQueryMsgTransTrendResponse>

JSON 格式

{
	"Data": {
		"Records": {
			"StatsDataDo": [{"X": "1570960800",
            "Y": "3"}]
		},
		"XUnit": "时间",
		"YUnit": "条/秒",
		"Title": "消息生产TPS"
	},
	"RequestId": "77B5727C-CCDF-4404-B7A0-EC0D3CF4BEDE"
}

错误码

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