查詢消費堆積__消費管理相關接口_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-阿裏雲