全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网
消息队列 MQ

查询分组列表

更新时间:2017-08-11 15:07:57   分享:   

OnsMqttGroupIdList 接口用于查询目标 Region 里当前用户所拥有的所有 GroupId。

使用场景

获取 GroupId 列表的接口一般用于管理用户所有 GroupId 的场景,首先获取列表,然后可以针对单个 GroupId 进行相关的数据查询。

请求参数列表

名称 类型 是否必须 描述
OnsRegionId String 当前操作的 MQ 所在区域,详情参见公共术语页面
OnsPlatform String 请求来源,默认是从 POP 平台
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求独一无二,用于排查定位问题
HelpUrl String 帮助链接
Data MqttGroupIdDo GroupId 信息数据结构

MqttGroupIdDo 数据结构

名称 类型 描述
Id Long 数据编号
ChannelId Integer 访问的途径编号,阿里云环境为0
OnsRegionId String MQ 的 RegionId
RegionName String MQ 的 Region 名称
Owner String GroupId 所属账号
GroupId String GroupId
Topic String 该 GroupId 关联的 Parent Topic
Status Integer 当前状态(0 服务中 1 冻结 2 暂停)
CreateTime Long 创建时间,单位是毫秒时间戳
UpdateTime Long 最后更新时间,单位是毫秒时间戳

错误码列表

相关 API

  • OnsMqttQueryClientByGroupId:根据 GroupId 查询当前在线客户端数量
  • OnsMqttQueryHistoryOnline:根据 GroupId 查询历史在线数统计曲线

使用示例

本示例仅仅提供一个参考,从杭州接入点接入,获取杭州 Region 的所有 GroupId。

  1. public static void main(String[] args) {
  2. String regionId = "cn-hangzhou";
  3. String accessKey = "XXXXXXXXXXXXXXXXX";
  4. String secretKey = "XXXXXXXXXXXXXXXXX";
  5. String endPointName ="cn-hangzhou";
  6. String productName ="Ons";
  7. String domain ="ons.cn-hangzhou.aliyuncs.com";
  8. /**
  9. *根据自己所在的区域选择Region后,设置对应的接入点
  10. */
  11. try {
  12. DefaultProfile.addEndpoint(endPointName,regionId,productName,domain);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. IClientProfile profile= DefaultProfile.getProfile(regionId,accessKey,secretKey);
  17. IAcsClient iAcsClient= new DefaultAcsClient(profile);
  18. OnsMqttGroupIdListRequest request = new OnsMqttGroupIdListRequest();
  19. /**
  20. *ONSRegionId是指你需要API访问MQ哪个区域的资源。
  21. *该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值
  22. */
  23. request.setOnsRegionId("XXXX");
  24. request.setPreventCache(System.currentTimeMillis());
  25. request.setAcceptFormat(FormatType.JSON);
  26. try {
  27. OnsMqttGroupIdListResponse response=iAcsClient.getAcsResponse(request);
  28. List<OnsMqttGroupIdListResponse.MqttGroupIdDo> groupIdList=response.getData();
  29. for(OnsMqttGroupIdListResponse.MqttGroupIdDo groupDo:groupIdList){
  30. System.out.println(groupDo.getId()+" "+
  31. groupDo.getChannelId()+" "+
  32. groupDo.getOnsRegionId()+" "+
  33. groupDo.getRegionName()+" "+
  34. groupDo.getOwner()+" "+
  35. groupDo.getGroupId()+" "+
  36. groupDo.getTopic()+" "+
  37. groupDo.getStatus()+" "+
  38. groupDo.getCreateTime()+" "+
  39. groupDo.getUpdateTime());
  40. }
  41. } catch (ServerException e) {
  42. e.printStackTrace();
  43. } catch (ClientException e) {
  44. e.printStackTrace();
  45. }
  46. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?