Query consumer status

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

Description

This interface queries the detailed status data of a specified Consumer ID, including subscription relation checking, consumption TPS count, server load balancer status, consumer connection, and so on.

Usage

This interface identifies the detailed status of the Consumer ID. It’s called when you need to troubleshoot the exceptions after having a rough idea of the consumption accumulation and client connection status. It tells if the subscription relations of a specified Consumer Group (CID) are consistent, if the server load balancer is normal, and the Jstack information of online clients.

Note: this interface calls a number of backend interfaces to aggregate data, and the query speed is relatively slow, so it’s not recommended to call it frequently.

Request parameters

Response parameters

ConsumerStatusDo data structure

ConnectionDo data structure

DetailInTopicDo data structure

ConsumerConnectionInfoDo data structure

SubscriptionData data structure

ConsumerRunningDataDo data structure

ThreadTrackDo data structure

Related APIs

• OnsConsumerAccumulate: queries the consumption accumulation
• OnsConsumerConnection: queries the client connection of a consumer

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);
          OnsConsumerStatusRequest request = new OnsConsumerStatusRequest();
            /**
            *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.setDetail(true);
          request.setNeedJstack(false);
          try {
              OnsConsumerStatusResponse response=iAcsClient.getAcsResponse(request);
              OnsConsumerStatusResponse.Data data =response.getData();
              List<OnsConsumerStatusResponse.Data.ConnectionDo> connectionDoList = data.getConnectionSet();
              List<OnsConsumerStatusResponse.Data.DetailInTopicDo> detailInTopicDoList =data.getDetailInTopicList();
              List<OnsConsumerStatusResponse.Data.ConsumerConnectionInfoDo> consumerConnectionInfoDoList =data.getConsumerConnectionInfoList();
              System.out.print(data.getOnline()+"  "+data.getTotalDiff()+"  "+data.getConsumeTps()+"  "+
              data.getLastTimestamp()+"  "+data.getDelayTime()+"  "+data.getConsumeModel()+
                      "  "+data.getSubscriptionSame()+"  "+data.getRebalanceOK());
          } catch (ServerException e) {
              e.printStackTrace();
          } catch (ClientException e) {
              e.printStackTrace();
          }
      }