550      阿裏雲

查詢消費狀態__消費管理相關接口_Open API_消息隊列 MQ-阿裏雲

本文介紹 OnsConsumerStatus 接口，該接口可以查詢指定訂閱組的詳細狀態數據，包含訂閱關係檢查，消費 TPS 統計，負載均衡狀態，消費端連接等。

1. 使用場景

消費者狀態查詢接口用於定位訂閱組的詳細狀態，一般用於在粗略判斷消費堆積以及客戶端在線情況後，需要排查消費異常的原因時調用.可以判斷出指定消費組(CID)的訂閱關係是否一致，負載均衡是否正常，以及在線客戶端的 Jstack 信息等。

注意：消費者狀態查詢接口需要調用後端大量接口完成數據聚合，因此查詢速度慢，不建議頻繁調用。

2. 請求參數列表

3. 返回參數列表

ConsumerStatusDo 數據結構

ConnectionDo 數據結構

DetailInTopicDo 數據結構

ConsumerConnectionInfoDo 數據結構

SubscriptionData 數據結構

ConsumerRunningDataDo 數據結構

ThreadTrackDo 數據結構

4. 相關 API

• OnsConsumerAccumulate：查詢消費堆積
• OnsConsumerConnection：查詢消費方客戶端連接

5. 使用示例

調用示例

   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);
          OnsConsumerStatusRequest request = new OnsConsumerStatusRequest();
            /**
            *ONSRegionId是指你需要API訪問MQ哪個區域的資源.
            *該值必須要根據OnsRegionList方法獲取的列表來選擇和配置，因為OnsRegionId是變動的，不能夠寫固定值
            */
          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();
          }
      }