阅读627 返回首页    go 魔兽


查询消费进度__消费管理相关接口_Open API_消息队列 MQ-阿里云

本文介绍 OnsConsumerTimeSpan 接口,该接口提供查询当前订阅组订阅的 Topic 的最新消息时间戳以及消费的最新时间戳。

1. 使用场景

使用本接口可以解决查询某个 Topic 当前服务器上存在的消息的最新时间以及最早时间,以及查询消费端最近消费的时间的需求。一般用于展示消费进度的概况,和 ConsumeAccumulate 接口配合使用。

2. 请求参数列表

名称 类型 是否必须 描述
OnsRegionId String 当前查询 MQ 所在区域,可以通过 ONSRegionList 方法获取
OnsPlatform String 该请求来源,默认是从 POP 平台
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可
ConsumerId String 需要查询的消费端 CID
Topic String 需要查询的消费的 Topic

3. 返回参数列表

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

Data 数据结构

成员 类型 描述
Topic String 查询的 Topic 名称
MinTimeStamp Long 整个 Topic 目前存储的最新的消息的时间
MaxTimeStamp Long 整个 Topic 目前存储的最老的消息的时间
ConsumeTimeStamp Long 当前 group 消费该 Topic 的最新的时间

4. 相关 API

  • OnsConsumerAccumulate:查询消费堆积
  • OnsConsumerStatus:查询消费端详情
  • OnsConsumerResetOffset:重置位点和清除消息

5. 使用示例

调用示例

  1. public static void main(String []args) {
  2. String regionId = "cn-hangzhou";
  3. String regionId = "cn-hangzhou";
  4. String accessKey = "XXXXXXXXXXXXXXXXX";
  5. String secretKey = "XXXXXXXXXXXXXXXXX";
  6. String endPointName ="cn-hangzhou";
  7. String productName ="Ons";
  8. String domain ="ons.cn-hangzhou.aliyuncs.com";
  9. /**
  10. *根据自己需要访问的区域选择Region,并设置对应的接入点
  11. */
  12. try {
  13. DefaultProfile.addEndpoint(endPointName,regionId,productName,domain);
  14. } catch (ClientException e) {
  15. e.printStackTrace();
  16. }
  17. IClientProfile profile= DefaultProfile.getProfile(regionId,accessKey,secretKey);
  18. IAcsClient iAcsClient= new DefaultAcsClient(profile);
  19. OnsConsumerTimeSpanRequest request = new OnsConsumerTimeSpanRequest();
  20. /**
  21. *ONSRegionId是指你需要API访问MQ哪个区域的资源.
  22. *该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值
  23. */
  24. request.setOnsRegionId("daily");
  25. request.setPreventCache(System.currentTimeMillis());
  26. request.setAcceptFormat(FormatType.JSON);
  27. request.setConsumerId("CID_Mingduan");
  28. request.setTopic("MingduanTest12");
  29. try {
  30. OnsConsumerTimeSpanResponse response=iAcsClient.getAcsResponse(request);
  31. OnsConsumerTimeSpanResponse.Data data =response.getData();
  32. System.out.println(data.getTopic()+"n"+
  33. data.getConsumeTimeStamp()+"n"+
  34. data.getMaxTimeStamp()+"n"+
  35. data.getMinTimeStamp());
  36. } catch (ServerException e) {
  37. e.printStackTrace();
  38. } catch (ClientException e) {
  39. e.printStackTrace();
  40. }
  41. }

最后更新:2016-11-23 18:56:00

  上一篇:go 重置消费位点__消费管理相关接口_Open API_消息队列 MQ-阿里云
  下一篇:go 消息轨迹查询__消息管理相关接口_Open API_消息队列 MQ-阿里云