Query accumulation

This interface is exclusive for MQ Platinum edition users. For more information, go to Platinum Edition Purchase Page.

Description

This interface queries the message accumulation of a specified Consumer ID and retrieves the number of not consumed messages and an estimated delay time.

Usage

Consumer accumulate query is used when you need to understand the consumption progress of the Consumer ID in the production environment, and to have a rough idea about the message consumption and delays.

Request parameters

Response parameters

Data structure

DetailInTopicList data structure

Related APIs

• OnsConsumerStatus: queries the consumer status details
• OnsConsumerConnection: queries the consumer connection
• OnsResetOffset: clears the consumption accumulation

Example

    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";
            /**
            *Select Region based on the region you will access, and set the corresponding access point.
            */
            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 refers to the resource of the region of MQ required to be accessed by API.
            *This value must be selected and configured by the list obtained through the OnsRegionList method because OnsRegionId is changing, and cannot be written as a fixed value.
            */
            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();
            }
        }