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

搜索指定 Topic 详细信息

更新时间:2017-08-11 14:51:25

OnsTopicSeacrh 接口用于根据搜索条件搜索指定账号下所有的 Topic 信息列表。

使用场景

该接口适用于查询 Topic 信息时没有精确的 Topic 名称的情况,一般用于获取整个 Topic 列表,在选择特定的 Topic 后基于 OnsTopicGet 接口精确查询。

请求参数列表

名称 类型 是否必须 描述
OnsRegionId String 当前查询 MQ 所在区域,可以通过 ONSRegionList 方法获取,参见公共术语
OnsPlatform String 该请求来源,默认是从 POP 平台
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可
Search String 输入的搜索条件,可以是 Topic 或者 appname 等字段

3. 返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求独一无二
HelpUrl String 帮助链接
Data List(PublishInfoDo) 返回所有已发布的 Topic 信息列表

PublishInfoDo 数据结构

成员 类型 描述
id Long 该 Topic 信息编号
channelId Integer 该 Topic 所在区域 ID,0代表阿里云,1代表聚石塔
channelName String 该 Topic 所在区域名称,ALIYUN,CLOUD,…
onsRegionId Long 该 Topic 所在区域 ID,就是 ONSRegionList 方法获取的内容
regionName String 该 Topic 所在区域名称
topic String Topic 名称
owner String Topic 所有者编号,为阿里云的 uid
relation Integer 所有关系编号1为持有者,2为可以发布,4为可以订阅,6为可以发布和订阅
relationName String 所有关系名称,例如持有者、可订阅、可发布、可发布订阅
status Integer 当前状态编号(0 服务中 1 冻结 2 暂停)
statusName String 当前状态别名,服务中,
appkey Integer null
createTime Long 创建时间
updateTime Long 更新时间
remark String 备注信息

4. 相关 API

  • OnsTopicCreate:创建 Topic
  • OnsTopicList:查看 Topic 列表
  • OnsPublishDelete:删除发布关系
  • OnsSubscribeDelete:删除订阅关系

5. 使用示例

本示例仅仅提供一个参考,从华东1接入点接入,查询当前用户下所有的 Topic 列表。

  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(endPointNameregionIdproductNamedomain);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. IClientProfile profile= DefaultProfile.getProfile(regionIdaccessKeysecretKey);
  17. IAcsClient IAcsClient= new DefaultAcsClient(profile);
  18. OnsTopicSearchRequest request = new OnsTopicSearchRequest();
  19. request.setAcceptFormat(FormatType.JSON);
  20. /**
  21. *ONSRegionId是指你需要API访问MQ哪个区域的资源.
  22. *该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值
  23. */
  24. request.setOnsRegionId("daily");
  25. request.setPreventCache(System.currentTimeMillis());
  26. request.setSearch("JODIE_TEST_28dd");
  27. try {
  28. OnsTopicSearchResponse response = IAcsClient.getAcsResponse(request);
  29. List<OnsTopicSearchResponse.PublishInfoDo> publishInfoDoList=response.getData();
  30. for(OnsTopicSearchResponse.PublishInfoDo publishInfoDo:publishInfoDoList){
  31. System.out.println(publishInfoDo.getTopic()+" "+publishInfoDo.getOwner());
  32. }
  33. System.out.println(response.getRequestId());
  34. } catch (ClientException e) {
  35. e.printStackTrace();
  36. }
  37. catch (Exception e) {
  38. e.printStackTrace();
  39. }
  40. }
本文导读目录