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();
          }
      }