根据 Group ID(GID)和给定的时间段查询历史在线设备的数量曲线。
使用场景
OnsMqttQueryHistoryOnline 接口一般用于生成业务报表。
由于 OpenAPI 面向的场景是用户自定义管控开发,服务端会对过快的调用进行限流(每分钟 30 次),因此不要在业务的主流程中使用本接口。如需判断设备是否在线,请使用设备上下线通知功能。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsMqttQueryHistoryOnline |
系统规定参数。取值:OnsMqttQueryHistoryOnline。 |
BeginTime | Long | 是 | 1570957261 |
查询的起始时间 |
EndTime | Long | 是 | 1570962601 |
查询的终止时间,起止时间范围建议尽可能在当天,否则后端会自动截断 |
GroupId | String | 是 | GID_test |
需查询的目标 GID |
InstanceId | String | 否 | post-cn-0pp12gl**** |
需查询的 GID 所属的 MQTT 实例 ID。针对有独立命名空间的实例,该参数为必填。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data |
数据集合 |
||
Records | Array |
采集点信息 |
|
StatsDataDo |
采集点信息 |
||
X | Long | 1570960501 |
横轴,毫秒时间戳 |
Y | Float | 2 |
纵轴,数量 |
Title | String | 客户端连接数 |
Table 的名称 |
XUnit | String | 时间 |
时间戳,单位毫秒 |
YUnit | String | 数量 |
数量 |
RequestId | String | 5BC91C2F-C202-4AD8-9322-9F2AB3E320DC |
为公共参数,每个请求的 ID 都是唯一的 |
示例
请求示例
http(s)://[Endpoint]/?Action=OnsMqttQueryHistoryOnline
&BeginTime=1570959001
&EndTime=1570962601
&GroupId=GID_test
&InstanceId=post-cn-0pp12gl****
&<公共请求参数>
正常返回示例
XML
格式
<OnsMqttQueryHistoryOnlineResponse>
<Data>
<Records>
<StatsDataDo>
<X>1570960501</X>
<Y>2</Y>
</StatsDataDo>
</Records>
<XUnit>时间</XUnit>
<YUnit>数量</YUnit>
<Title>客户端连接数</Title>
</Data>
<RequestId>5BC91C2F-C202-4AD8-9322-9F2AB3E320DC</RequestId>
</OnsMqttQueryHistoryOnlineResponse>
JSON
格式
{
"Data":{
"XUnit":"时间",
"Records":{
"StatsDataDo":[
{
"Y":"2",
"X":"1570960501"
}
]
},
"YUnit":"数量",
"Title":"客户端连接数"
},
"RequestId":"5BC91C2F-C202-4AD8-9322-9F2AB3E320DC"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交