全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
消息队列 MQ

根据 Topic 查询消息

更新时间:2017-12-15 20:40:47

OnsMessagePageQueryByTopic 接口通过传入 Topic 和时间段,分页查询指定时间段内存在的所有消息。

使用场景

根据 Topic 查询消息属于范围查询,查询结果会通过分页的方式展示给调用方,仅适用于没有任何搜索条件(MsgId 和 MsgKey)情况下的查询。

注意:根据 Topic 查询,需要尽可能缩短查询的时间区间,否则匹配的消息过多,将无法定位问题。

调用方式

  • 首先,传入 Topic,起止时间,以及每页的大小,进行分页查询,如果有消息,默认返回第一页的消息以及总页数和查询 Task ID。
  • 根据返回的结果中的查询 Task ID,进行后续取消息,取消息时传入 Task ID 以及当前页数。

请求参数列表

名称 类型 是否必须 描述
OnsRegionId String 当前查询 MQ 所在区域,可以通过 OnsRegionList 方法获取
OnsPlatform String 该请求来源,默认是从 POP 平台
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可
Topic String 需要查询的消息的 Topic
BeginTime Long 查询范围的起始时间戳
EndTime Long 查询范围的终止时间戳
TaskId String 查询任务的 ID,首次查询不需要输入,后续取消息必须传入,根据第一次的返回结果取出该字段
CurrentPage Integer 当前取第几页消息,从1开始递增,取消息时不可超过最大页数
PageSize Integer 分页查询,每页最多显示消息数量,默认是20,最小5条,最多50条

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求独一无二
HelpUrl String 帮助链接
MsgFoundDo MsgFoundDo 查询结果

MsgFoundDo 数据结构

名称 类型 描述
TaskId String 第一次新建查询时,返回的 Task ID,用于后续取消息用
MaxPageCount Long 查询结果最大页数
CurrentPage Long 当前位于第几页
Data List(OnsRestMessageDo) 当前页的消息集合,该类型与 messageGetById 的返回结果一致

相关 API

  • OnsMessageGetByMsgId:根据 MsgId 精确查询消息
  • OnsMessageGetByMsgKey:根据 MsgKey 模糊查询消息

使用示例

新建查询调用示例


   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);
           OnsMessagePageQueryByTopicRequest request = new OnsMessagePageQueryByTopicRequest();
            /**
            *ONSRegionId 是指你需要 API 访问 MQ 哪个区域的资源.
            *该值必须要根据 OnsRegionList 方法获取的列表来选择和配置,因为 OnsRegionId 是变动的,不能够写固定值
            */
           request.setOnsRegionId("daily");
           request.setPreventCache(System.currentTimeMillis());
           request.setAcceptFormat(FormatType.JSON);
           request.setTopic("MingduanTest");
           request.setBeginTime(System.currentTimeMillis()-24*3600*1000);
           request.setEndTime(System.currentTimeMillis());
           request.setCurrentPage(1);
           request.setPageSize(20);
           try {
                   OnsMessagePageQueryByTopicResponse response = iAcsClient.getAcsResponse(request);
               } catch (ServerException e) {
                   e.printStackTrace();
               } catch (ClientException e) {
                   e.printStackTrace();
               }
       }

分页取消息调用示例


   public static void main(String []args) {
           String regionId = "cn-hangzhou";
           String accessKey = "XXXXX";
           String secretKey = "XXXXX";
           IClientProfile profile = DefaultProfile.getProfile(regionId, accessKey, secretKey);
           IAcsClient iAcsClient = new DefaultAcsClient(profile);
           OnsMessagePageQueryByTopicRequest request = new OnsMessagePageQueryByTopicRequest();
            /**
            *ONSRegionId 是指你需要 API 访问 MQ 哪个区域的资源.
            *该值必须要根据 OnsRegionList 方法获取的列表来选择和配置,因为 OnsRegionId 是变动的,不能够写固定值
            */
           request.setOnsRegionId("daily");
           request.setPreventCache(System.currentTimeMillis());
           request.setAcceptFormat(FormatType.JSON);
           request.setTopic("MingduanTest");
           request.setBeginTime(System.currentTimeMillis()-24*3600*1000);
           request.setEndTime(System.currentTimeMillis());
           request.setCurrentPage(3);
           request.setTaskId("0ADA91A600002A9F000002ADDA8137E8");
           try {
                   OnsMessagePageQueryByTopicResponse response = iAcsClient.getAcsResponse(request);
               } catch (ServerException e) {
                   e.printStackTrace();
               } catch (ClientException e) {
                   e.printStackTrace();
               }
       }
本文导读目录