943      阿里云

根据 Key 查询消息__消息管理相关接口_Open API_消息队列 MQ-阿里云

本文档介绍 OnsMessageGetByMsgKey 接口，该接口通过传入 Topic 和 MsgKey 进行模糊查询，得到符合条件的消息的信息列表。

1. 使用场景

根据 MsgKey 查询消息属于模糊查询，由于业务方的 key 可能不唯一，所以查询结果可能为多条。一般用在业务方无法获取 MsgId 的场景下，先进行模糊查询得到 msgId 列表，再调用 OnsMessageGetByMsgId 接口查询。

2. 请求参数列表

3. 返回参数列表

OnsRestMessageDo 数据结构

4. 相关 API

• OnsMesageGetByMsgId：根据 MsgId 精确查询消息
• OnsMessageGetByTopic：根据 Topic 进行时间范围查询

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);
           OnsMessageGetByKeyRequest request = new OnsMessageGetByKeyRequest();
            /**
            *ONSRegionId是指你需要API访问MQ哪个区域的资源.
            *该值必须要根据OnsRegionList方法获取的列表来选择和配置，因为OnsRegionId是变动的，不能够写固定值
            */
           request.setOnsRegionId("daily");
           request.setPreventCache(System.currentTimeMillis());
           request.setAcceptFormat(FormatType.JSON);
           request.setTopic("MingduanTest");
           request.setKey("hello");
           try {
               OnsMessageGetByKeyResponse response = iAcsClient.getAcsResponse(request);
               List<OnsMessageGetByKeyResponse.OnsRestMessageDo> onsRestMessageDoList=response.getData();
               for(OnsMessageGetByKeyResponse.OnsRestMessageDo onsRestMessageDo:onsRestMessageDoList){
                   byte[] messageBody = Base64.decode(onsRestMessageDo.getBody());
                   String message =new String (messageBody);
                   System.out.println(onsRestMessageDo.getTopic()+"  "+message+"  "+
                   onsRestMessageDo.getFlag()+" "+
                   onsRestMessageDo.getBornHost()+"  "+
                   onsRestMessageDo.getStoreSize()+"  "+
                   onsRestMessageDo.getStoreHost()+"  "+
                   onsRestMessageDo.getStoreTimestamp()+"  "+
                   onsRestMessageDo.getReconsumeTimes());
               }
           } catch (ServerException e) {
               e.printStackTrace();
           } catch (ClientException e) {
               e.printStackTrace();
           }