如何查询分组在线数量

OnsMqttQueryClientByGroupId 接口根据 GroupId 统计属于该分组下的在线设备的数量。

使用场景

查询在线设备数量的接口一般用于业务分析，统计一个 GroupId 分组下终端设备的活跃程度。

请求参数列表

名称    类型    是否必须    描述
OnsRegionId    String    是    当前操作的 MQ 所在区域，详情参见公共术语页面
OnsPlatform    String    否    请求来源，默认是从 POP 平台
PreventCache    Long    是    用于 CSRF 校验，设置为系统当前时间即可
GroupId    String    是    需要查询的目标分组 GroupId
返回参数列表

名称    类型    描述
RequestId    String    为公共参数，每个请求独一无二，用于排查定位问题
HelpUrl    String    帮助链接
MqttClientSetDo    MqttClientSetDo    分组在线信息数据结构
MqttClientSetDo 数据结构

名称    类型    描述
OnlineCount    Long    分组所有在线设备数量
错误码列表

无

相关 API

OnsMqttQueryClientByTopic：根据 Topic 查询当前订阅该 Topic 的在线客户端数量
使用示例

本示例仅仅提供一个参考，从杭州接入点接入，查询指定 groupId 的在线数量信息。

    public static void main(String[] args) {
        String regionId = "cn-hangzhou";
        String accessKey = "XXXXXXXXXXXXXXXXX";
        String secretKey = "XXXXXXXXXXXXXXXXX";
        String endPointName ="cn-hangzhou";
        String productName ="Ons";
        String domain ="ons.cn-hangzhou.aliyuncs.com";
        /**
        *根据自己所在的区域选择Region后,设置对应的接入点
        */
        try {
            DefaultProfile.addEndpoint(endPointName,regionId,productName,domain);
        } catch (ClientException e) {
            e.printStackTrace();
        }
        IClientProfile profile= DefaultProfile.getProfile(regionId,accessKey,secretKey);
        IAcsClient iAcsClient= new DefaultAcsClient(profile);
        OnsMqttQueryClientByGroupIdRequest request = new OnsMqttQueryClientByGroupIdRequest();
        /**
        *ONSRegionId是指你需要API访问MQ哪个区域的资源。
        *该值必须要根据OnsRegionList方法获取的列表来选择和配置，因为OnsRegionId是变动的，不能够写固定值
        */
        request.setOnsRegionId("XXXX");
        request.setPreventCache(System.currentTimeMillis());
        request.setAcceptFormat(FormatType.JSON);
        request.setGroupId("GID_XXXXX");
        try {
                 OnsMqttQueryClientByGroupIdResponse response = iAcsClient.getAcsResponse(request);
                OnsMqttQueryClientByGroupIdResponse.MqttClientSetDo clientSetDo = response.getMqttClientSetDo();
                System.out.println(clientSetDo.getOnlineCount() + "  " +
                        clientSetDo.getPersistCount() + "  ");
        } catch (ServerException e) {
          e.printStackTrace();
        } catch (ClientException e) {
          e.printStackTrace();
        }
    }