Query consumption progress

OnsConsumerTimeSpan interface queries the latest message time stamp of the Topic subscribed by the current Consumer ID, and the latest consumption time stamp.

Usage

This interface can be used for querying the latest and earliest time of a Topic’s messages on the server, and querying the latest consumption time of the consumer. It’s usually used in combination with the ConsumeAccumulate interface for getting a rough idea of the consumption progress.

Request parameters

Response parameters

Data structure

Related APIs

• OnsConsumerAccumulate: queries the consumption accumulation
• OnsConsumerStatus: queries the consumer details
• OnsConsumerResetOffset: resets the offset and clears messages

Example

   public static void main(String []args) {
          String regionId = "cn-hangzhou";
                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);
                  OnsConsumerTimeSpanRequest request = new OnsConsumerTimeSpanRequest();
                    /**
                    *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.setConsumerId("CID_Mingduan");
                  request.setTopic("MingduanTest12");
                  try {
                      OnsConsumerTimeSpanResponse response=iAcsClient.getAcsResponse(request);
                      OnsConsumerTimeSpanResponse.Data data =response.getData();
                      System.out.println(data.getTopic()+"\n"+
                      data.getConsumeTimeStamp()+"\n"+
                      data.getMaxTimeStamp()+"\n"+
                      data.getMinTimeStamp());
                  } catch (ServerException e) {
                      e.printStackTrace();
                  } catch (ClientException e) {
                      e.printStackTrace();
                  }
      }