閱讀754 返回首頁    go 阿裏雲


獲取 Topic 列表__Topic 相關接口_Open API_消息隊列 MQ-阿裏雲

本文介紹 OnsTopicList 接口,用於查詢當前用戶下所有 Topic 的列表信息。

1. 使用場景

查詢賬號下所有 Topic 的列表信息,一般用於生成資源列表的場景,並不查看具體信息。

2. 請求參數列表

名稱 類型 是否必須 描述
OnsRegionId String 當前查詢 MQ 所在區域,可以通過 ONSRegionList 方法獲取,參見公共術語
OnsPlatform String 該請求來源,默認是從 POP 平台
PreventCache Long 用於 CSRF 校驗,設置為係統當前時間即可
Topic String 查詢指定 Topic 時設置,否則查詢所有 Topic

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(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. OnsTopicListRequest request = new OnsTopicListRequest();
  19. /**
  20. *ONSRegionId是指你需要API訪問MQ哪個區域的資源.
  21. *該值必須要根據OnsRegionList方法獲取的列表來選擇和配置,因為OnsRegionId是變動的,不能夠寫固定值
  22. */
  23. request.setOnsRegionId("daily");
  24. request.setPreventCache(System.currentTimeMillis());
  25. request.setTopic("XXXXXXXXXXXXX");
  26. try {
  27. OnsTopicListResponse response = IAcsClient.getAcsResponse(request);
  28. List<OnsTopicListResponse.PublishInfoDo> publishInfoDoList=response.getData();
  29. for(OnsTopicListResponse.PublishInfoDo publishInfoDo:publishInfoDoList){
  30. System.out.println(publishInfoDo.getTopic()+" "+ publishInfoDo.getOwner());
  31. }
  32. } catch (ServerException e) {
  33. e.printStackTrace();
  34. } catch (ClientException e) {
  35. e.printStackTrace();
  36. }
  37. }

最後更新:2016-12-19 14:53:18

  上一篇:go 錯誤碼列表__Open API_消息隊列 MQ-阿裏雲
  下一篇:go 查詢指定 Topic 狀態__Topic 相關接口_Open API_消息隊列 MQ-阿裏雲