根据 Group ID(GID)统计属于该 Group 下的在线设备的数量。

使用场景

OnsMqttQueryClientByGroupId 接口一般用于业务分析,统计一个 GID 下终端设备的活跃程度。

由于 OpenAPI 面向的场景是用户自定义管控开发,服务端会对过快的调用进行限流(每分钟 30 次),因此不要在业务的主流程中使用本接口。

调试

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

请求参数

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

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

GroupId String GID_test

需查询的 GID

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

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

返回数据

名称 类型 示例值 描述
MqttClientSetDo

Group 下的设备在线信息数据结构

OnlineCount Long 1

Group 所有在线设备数量

RequestId String E54CBFC3-7700-44BC-8FFA-B61E471D4876

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

示例

请求示例


http(s)://[Endpoint]/?Action=OnsMqttQueryClientByGroupId
&GroupId=GID_test
&InstanceId=post-cn-0pp12gl****
&<公共请求参数>

正常返回示例

XML 格式

<OnsMqttQueryClientByGroupIdResponse>
  <RequestId>E54CBFC3-7700-44BC-8FFA-B61E471D4876</RequestId>
  <MqttClientSetDo>
        <OnlineCount>1</OnlineCount>
  </MqttClientSetDo>
</OnsMqttQueryClientByGroupIdResponse>

JSON 格式

{
	"RequestId":"E54CBFC3-7700-44BC-8FFA-B61E471D4876",
	"MqttClientSetDo":{
		"OnlineCount":1
	}
}

错误码

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