如何查询消费堆积

本接口限企业铂金版客户专用，请前往铂金版购买页面查看详情。

描述

OnsConsumerAccumulate 接口用于查询指定订阅组的消费堆积情况，可以获取到订阅组当前未消费的消息数以及大概的延迟时间。

使用场景

消费堆积查询一般在生产环境中需要关注订阅组消费进度时使用，用于粗略判断消息消费情况和延迟情况。

请求参数列表

名称    类型    是否必须    描述
OnsRegionId    String    是    当前查询 MQ 所在区域，可以通过 ONSRegionList 方法获取
OnsPlatform    String    否    该请求来源，默认是从 POP 平台
PreventCache    Long    是    用于 CSRF 校验，设置为系统当前时间即可
ConsumerId    String    是    需要查询的消费端 CID
Detail    Boolean    否    是否查询详细信息，默认为否
返回参数列表

名称    类型    描述
RequestId    String    为公共参数，每个请求独一无二
HelpUrl    String    帮助链接
Data    Data    指定 Consumer 的消费堆积情况
Data 数据结构

成员    类型    描述
OnLine    Boolean    当前消费者是否在线
TotalDiff    Long    当前 Consumer ID 订阅的所有 Topic 的消息总堆积数
ConsumeTps    Float    当前消费 TPS
LastTimestamp    Long    最后更新时刻
DelayTime    Long    延迟时间
DetailInTopicList    List(OnsConsumerAccumulateResponse.Data.DetailInTopicDo)    各个 Topic 具体情况
DetailInTopicList 数据结构

成员    类型    描述
Topic    String    Topic 名称
TotalDiff    Long    当前 Topic 的消费堆积
LastTimestamp    Long    最后更新时刻
DelayTime    Long    当前 Topic 的消费延迟时间
相关 API

OnsConsumerStatus：消费者状态详情查询
OnsConsumerConnection：消费者连接查询
OnsResetOffset：消费清理堆积
使用示例

    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);
            OnsConsumerAccumulateRequest request = new OnsConsumerAccumulateRequest();
            //      request.setCluster("taobaodaily");
            /**
            *ONSRegionId是指你需要API访问MQ哪个区域的资源.
            *该值必须要根据OnsRegionList方法获取的列表来选择和配置，因为OnsRegionId是变动的，不能够写固定值
            */
            request.setOnsRegionId("daily");
            request.setPreventCache(System.currentTimeMillis());
            request.setAcceptFormat(FormatType.JSON);
            request.setDetail(true);
            request.setConsumerId("RTDSQ_1013_GROUP");
            try {
                OnsConsumerAccumulateResponse response=iAcsClient.getAcsResponse(request);
                OnsConsumerAccumulateResponse.Data data =response.getData();
                System.out.println(data.getOnline()+"  "+data.getTotalDiff()+"  "+data.getConsumeTps()+"  "
                        +data.getDelayTime()+"  "+data.getLastTimestamp());
                for (OnsConsumerAccumulateResponse.Data.DetailInTopicDo detailInTopicDo:data.getDetailInTopicList()){
                    System.out.println(detailInTopicDo.getTopic()+"  "
                            +detailInTopicDo.getTotalDiff()+"  "
                            +detailInTopicDo.getLastTimestamp()+"  "+detailInTopicDo.getDelayTime());
                }
            } catch (ServerException e) {
                e.printStackTrace();
            } catch (ClientException e) {
                e.printStackTrace();
            }
        }