查询消费堆积__消费管理相关接口_Open API_消息队列 MQ-阿里云
本文介绍 OnsConsumerAccumulate 接口,用于查询指定订阅组的消费堆积情况,可以获取到订阅组当前未消费的消息数以及大概的延迟时间。
1. 使用场景
消费堆积查询一般在生产环境中需要关注订阅组消费进度时使用,用于粗略判断消息消费情况和延迟情况。
2. 请求参数列表
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| OnsRegionId | String | 是 | 当前查询 MQ 所在区域,可以通过 ONSRegionList 方法获取 |
| OnsPlatform | String | 否 | 该请求来源,默认是从 POP 平台 |
| PreventCache | Long | 是 | 用于 CSRF 校验,设置为系统当前时间即可 |
| ConsumerId | String | 是 | 需要查询的消费端 CID |
| Detail | Boolean | 否 | 是否查询详细信息,默认为否 |
3. 返回参数列表
| 名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 为公共参数,每个请求独一无二 |
| HelpUrl | String | 帮助链接 |
| Data | Data | 指定 Consumer 的消费堆积情况 |
Data 数据结构
| 成员 | 类型 | 描述 |
|---|---|---|
| OnLine | Boolean | 当前消费者是否在线 |
| TotalDiff | Long | 当前 Consumer ID 订阅的所有 Topic 的消息总堆积数 |
| ConsumeTps | Float | 当前消费 TPS |
| LastTimestamp | Long | 最后更新时刻 |
| DelayTime | Long | 延迟时间 |
| DetailInTopicList | List(OnsConsumerAccumulateResponse.Data.DetailInTopicDo) | 各个 Topic 具体情况 |
DetailInTopicList 数据结构
| 成员 | 类型 | 描述 |
|---|---|---|
| Topic | String | Topic 名称 |
| TotalDiff | Long | 当前 Topic 的消费堆积 |
| LastTimestamp | Long | 最后更新时刻 |
| DelayTime | Long | 当前 Topic 的消费延迟时间 |
4. 相关 API
- OnsConsumerStatus:消费者状态详情查询
- OnsConsumerConnection:消费者连接查询
- OnsResetOffset:消费清理堆积
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);OnsConsumerAccumulateRequest request = new OnsConsumerAccumulateRequest();// request.setCluster("taobaodaily");/***ONSRegionId是指你需要API访问MQ哪个区域的资源.*该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值*/request.setOnsRegionId("daily");request.setPreventCache(System.currentTimeMillis());request.setAcceptFormat(FormatType.JSON);request.setDetail(true);request.setConsumerId("RTDSQ_1013_GROUP");try {OnsConsumerAccumulateResponse response=iAcsClient.getAcsResponse(request);OnsConsumerAccumulateResponse.Data data =response.getData();System.out.println(data.getOnline()+" "+data.getTotalDiff()+" "+data.getConsumeTps()+" "+data.getDelayTime()+" "+data.getLastTimestamp());for (OnsConsumerAccumulateResponse.Data.DetailInTopicDo detailInTopicDo:data.getDetailInTopicList()){System.out.println(detailInTopicDo.getTopic()+" "+detailInTopicDo.getTotalDiff()+" "+detailInTopicDo.getLastTimestamp()+" "+detailInTopicDo.getDelayTime());}} catch (ServerException e) {e.printStackTrace();} catch (ClientException e) {e.printStackTrace();}}
最后更新:2016-11-23 18:55:40
上一篇:
查询 Topic 当前位点__Topic 相关接口_Open API_消息队列 MQ-阿里云
下一篇:
查询消费状态__消费管理相关接口_Open API_消息队列 MQ-阿里云
查找数据__数据管理手册_用户操作指南_大数据开发套件-阿里云
ApiInfo__数据类型_API_API 网关-阿里云
如何变更实名认证信息__实名认证_帐号实名认证_会员账号&实名认证-阿里云
宽行读取__最佳实践_表格存储-阿里云
发送普通消息__C/C++ SDK_TCP 接入(专业)_消息队列 MQ-阿里云
有关Multipart命令__osscmd_常用工具_对象存储 OSS-阿里云
RelatedItemType__数据类型_API 参考_云服务器 ECS-阿里云
查询弹性公网IP列表__弹性公网IP相关接口_API参考_专有网络 VPC-阿里云
表__基本概念_基本介绍_大数据计算服务-阿里云
修改查询删除伸缩规则__伸缩规则_用户指南_弹性伸缩-阿里云
相关内容
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云