754
阿裏雲
獲取 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 列表。
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);
OnsTopicListRequest request = new OnsTopicListRequest();
/**
*ONSRegionId是指你需要API訪問MQ哪個區域的資源.
*該值必須要根據OnsRegionList方法獲取的列表來選擇和配置,因為OnsRegionId是變動的,不能夠寫固定值
*/
request.setOnsRegionId("daily");
request.setPreventCache(System.currentTimeMillis());
request.setTopic("XXXXXXXXXXXXX");
try {
OnsTopicListResponse response = IAcsClient.getAcsResponse(request);
List<OnsTopicListResponse.PublishInfoDo> publishInfoDoList=response.getData();
for(OnsTopicListResponse.PublishInfoDo publishInfoDo:publishInfoDoList){
System.out.println(publishInfoDo.getTopic()+" "+ publishInfoDo.getOwner());
}
} catch (ServerException e) {
e.printStackTrace();
} catch (ClientException e) {
e.printStackTrace();
}
}
最後更新:2016-12-19 14:53:18
上一篇:
錯誤碼列表__Open API_消息隊列 MQ-阿裏雲
下一篇:
查詢指定 Topic 狀態__Topic 相關接口_Open API_消息隊列 MQ-阿裏雲
使用說明-python__SDK使用參考_服務器端API_阿裏雲物聯網套件-阿裏雲
查看實例詳情__實例管理_開放API_分布式關係型數據庫 DRDS-阿裏雲
數學函數__函數_SQL語法參考_雲數據庫 OceanBase-阿裏雲
C#/.NET: EnyimMemcached__客戶端連接實例_快速入門_雲數據庫 Memcache 版-阿裏雲
開通簡介__購買指導_訪問控製-阿裏雲
簡單路由藍綠發布策略__發布策略_用戶指南_容器服務-阿裏雲
HLS基礎接口__Media-C-SDK_SDK 參考_對象存儲 OSS-阿裏雲
GetHistograms__日誌庫相關接口_API-Reference_日誌服務-阿裏雲
實例狀態圖__附錄_API 參考_雲服務器 ECS-阿裏雲
編輯用戶__用戶管理_DMS for MongoDB_用戶指南(NoSQL)_數據管理-阿裏雲
相關內容
常見錯誤說明__附錄_大數據計算服務-阿裏雲
發送短信接口__API使用手冊_短信服務-阿裏雲
接口文檔__Android_安全組件教程_移動安全-阿裏雲
運營商錯誤碼(聯通)__常見問題_短信服務-阿裏雲
設置短信模板__使用手冊_短信服務-阿裏雲
OSS 權限問題及排查__常見錯誤及排除_最佳實踐_對象存儲 OSS-阿裏雲
消息通知__操作指南_批量計算-阿裏雲
設備端快速接入(MQTT)__快速開始_阿裏雲物聯網套件-阿裏雲
查詢API調用流量數據__API管理相關接口_API_API 網關-阿裏雲
使用STS訪問__JavaScript-SDK_SDK 參考_對象存儲 OSS-阿裏雲