558
阿裏雲
搜索指定發布信息__發布管理相關接口_Open API_消息隊列 MQ-阿裏雲
本文介紹 OnsPublishSearch 接口,調用該接口根據搜索條件查詢相關的發布關係。
1. 使用場景
OnsPublishSearch 接口一般用在用戶賬號下 PID 太多無法同時展現時,根據關鍵字搜索符合條件的發布關係,展現的數據格式和 OnsPublishGet 接口一致。
2. 請求參數列表
| 名稱 | 類型 | 是否必須 | 描述 |
|---|---|---|---|
| OnsRegionId | String | 是 | 當前查詢 MQ 所在區域,可以通過 OnsRegionList 方法獲取 |
| OnsPlatform | String | 否 | 該請求來源,默認是從 POP 平台 |
| PreventCache | Long | 是 | 用於 CSRF 校驗,設置為係統當前時間即可 |
| Search | String | 是 | 搜索的關鍵詞,可以是 Topic 或者 PID |
3. 返回參數列表
| 名稱 | 類型 | 描述 |
|---|---|---|
| RequestId | String | 為公共參數,每個請求獨一無二 |
| HelpUrl | String | 幫助鏈接 |
| Data | List(PublishInfoDo) | 查詢結果集合 |
PublishInfoDo數據結構
| 成員 | 類型 | 描述 |
|---|---|---|
| id | Long | 該發布信息在數據庫中的 ID |
| channelId | Integer | 該 Topic 所在區域 ID,0-ALIYUN,1-CLOUD,2,3,4 |
| channelName | String | 該 Topic 所在區域名稱,ALIYUN 代表阿裏雲,CLOUD 代表聚石塔,… |
| onsRegionId | Long | 該 Topic 所在區域 ID,就是 ONSRegionList 方法獲取的內容 |
| regionName | String | 該 Topic 所在區域名稱 |
| topic | String | Topic 名稱 |
| owner | String | Topic 所有者編號 |
| relation | Integer | 所有關係編號1為持有者,2為可以發布,4為可以訂閱,6為可以發布和訂閱 |
| relationName | String | 所有關係名稱,例如持有者、可訂閱、可發布、可發布訂閱 |
| status | Integer | 當前狀態編號0-服務中 |
| statusName | String | 當前狀態別名,服務中 |
| appkey | Integer | null |
| createTime | Long | 創建時間 |
| updateTime | Long | 更新時間 |
| remark | String | 備注,可以不填 |
4. 相關 API
- OnsPublishDelete:刪除發布關係
- OnsPublishGet:查詢發布關係
- OnsPublishCreate:新建發布關係
5. 使用示例
調用示例
本示例以 PID_Mingduan 為搜索條件搜索 daily 區域下相關的 PID 信息,並將結果打印。
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);OnsPublishSearchRequest request = new OnsPublishSearchRequest();/***ONSRegionId是指你需要API訪問MQ哪個區域的資源.*該值必須要根據OnsRegionList方法獲取的列表來選擇和配置,因為OnsRegionId是變動的,不能夠寫固定值*/request.setOnsRegionId("daily");request.setPreventCache(System.currentTimeMillis());request.setAcceptFormat(FormatType.JSON);request.setSearch("PID_Mingduan");try {OnsPublishSearchResponse response=iAcsClient.getAcsResponse(request);List<OnsPublishSearchResponse.PublishInfoDo> publishInfoDoList =response.getData();for (OnsPublishSearchResponse.PublishInfoDo publishInfoDo:publishInfoDoList){System.out.println(publishInfoDo.getId()+" "+publishInfoDo.getChannelId()+" "+publishInfoDo.getChannelName()+" "+publishInfoDo.getOnsRegionId()+" "+publishInfoDo.getRegionName()+" "+publishInfoDo.getOwner()+" "+publishInfoDo.getProducerId()+" "+publishInfoDo.getTopic()+" "+publishInfoDo.getStatus()+" "+publishInfoDo.getStatusName()+" "+publishInfoDo.getCreateTime()+" "+publishInfoDo.getUpdateTime());}} catch (ServerException e) {e.printStackTrace();} catch (ClientException e) {e.printStackTrace();}}
最後更新:2016-11-23 18:56:15
上一篇:
獲取所有發布信息__發布管理相關接口_Open API_消息隊列 MQ-阿裏雲
下一篇:
查詢指定訂閱信息__訂閱管理相關接口_Open API_消息隊列 MQ-阿裏雲
常見錯誤說明__附錄_大數據計算服務-阿裏雲
發送短信接口__API使用手冊_短信服務-阿裏雲
接口文檔__Android_安全組件教程_移動安全-阿裏雲
運營商錯誤碼(聯通)__常見問題_短信服務-阿裏雲
設置短信模板__使用手冊_短信服務-阿裏雲
OSS 權限問題及排查__常見錯誤及排除_最佳實踐_對象存儲 OSS-阿裏雲
消息通知__操作指南_批量計算-阿裏雲
設備端快速接入(MQTT)__快速開始_阿裏雲物聯網套件-阿裏雲
查詢API調用流量數據__API管理相關接口_API_API 網關-阿裏雲
使用STS訪問__JavaScript-SDK_SDK 參考_對象存儲 OSS-阿裏雲