1020
阿里云
搜索指定订阅信息__订阅管理相关接口_Open API_消息队列 MQ-阿里云
本文介绍 OnsSubscribeSearch 接口,调用该接口可以通过 Topic 或者 CID 信息搜索符合条件的 CID 信息。
1. 使用场景
OnsSubscribeSearch 接口一般用于不确定 CID 名称的时候,可以通过 Topic 来搜索 CID 信息。
2. 请求参数列表
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| OnsRegionId | String | 是 | 当前查询 MQ 所在区域,可以通过 OnsRegionList 方法获取 |
| OnsPlatform | String | 否 | 该请求来源,默认是从 POP 平台 |
| PreventCache | Long | 是 | 用于 CSRF 校验,设置为系统当前时间即可 |
| Search | String | 是 | 搜索的关键词,可以是 Topic 或者 CID |
3. 返回参数列表
| 名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 为公共参数,每个请求独一无二 |
| HelpUrl | String | 帮助链接 |
| Data | List(SubscribeInfoDo) | 查询到的订阅关系集合 |
SubscribeInfoDo 数据结构
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Long | 订阅信息在数据库中的索引编号 |
| channelId | Integer | 该 Topic 所在区域 ID,0-ALIYUN,1-CLOUD,2,3,4 |
| channelName | String | 该 Topic 所在区域名称,ALIYUN 代表阿里云,CLOUD 代表聚石塔,… |
| onsRegionId | Long | 该 Topic 所在区域 ID,就是 ONSRegionList 方法获取的内容 |
| regionName | String | 该 Topic 所在区域名称 |
| Owner | String | 该发布信息的拥有者 |
| ConsumerId | String | 消费集群 ID |
| Topic | String | Topic 名称 |
| Status | Long | 当前状态 |
| StatusName | String | 状态名称,服务中,已下线等 |
| CreateTime | Long | 创建时间 |
| UpdateTime | Long | 最后更新时间 |
4. 相关 API
- OnsSubcribeCreate:创建订阅关系
- OnsSubcribeDelete:删除订阅关系
- OnsSubscribeList:获取订阅关系列表
5. 使用示例
调用示例
本示例通过设定搜索条件 CID_Mingduan 来获取符合的 CID 信息,并打印。
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);OnsSubscriptionSearchRequest request = new OnsSubscriptionSearchRequest();/***ONSRegionId是指你需要API访问MQ哪个区域的资源.*该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值*/request.setOnsRegionId("daily");request.setPreventCache(System.currentTimeMillis());request.setAcceptFormat(FormatType.JSON);request.setSearch("CID_Mingduan");try {OnsSubscriptionSearchResponse response=iAcsClient.getAcsResponse(request);List<OnsSubscriptionSearchResponse.SubscribeInfoDo> subscribeInfoDoList=response.getData();for(OnsSubscriptionSearchResponse.SubscribeInfoDo subscribeInfoDo:subscribeInfoDoList){System.out.println(subscribeInfoDo.getId()+" "+subscribeInfoDo.getChannelId()+" "+subscribeInfoDo.getChannelName()+" "+subscribeInfoDo.getOnsRegionId()+" "+subscribeInfoDo.getRegionName()+" "+subscribeInfoDo.getOwner()+" "+subscribeInfoDo.getConsumerId()+" "+subscribeInfoDo.getTopic()+" "+subscribeInfoDo.getStatus()+" "+subscribeInfoDo.getStatusName()+" "+subscribeInfoDo.getCreateTime()+" "+subscribeInfoDo.getUpdateTime());}} catch (ServerException e) {e.printStackTrace();} catch (ClientException e) {e.printStackTrace();}}
最后更新:2016-11-23 18:56:29
上一篇:
获取所有订阅信息__订阅管理相关接口_Open API_消息队列 MQ-阿里云
下一篇:
获取用户 Region 信息__用户管理相关接口_Open API_消息队列 MQ-阿里云
高防IP结合WAF___常见接入问题_Web 应用防火墙-阿里云
删除解析记录__解析管理接口_API文档_云解析-阿里云
Agent说明__Agent_服务器安全(安骑士)-阿里云
.net__SDK手册_OpenAPI 2.0_移动推送-阿里云
查询集群详情__集群_API参考_E-MapReduce-阿里云
处理非结构化数据__快速开始_大数据计算服务-阿里云
SDK本地目录配置__配置步骤_快速开始_Eclipse 插件-阿里云
发布服务__使用说明_用户手册_云服务总线 CSB-阿里云
图文识别异步调用接口__OCR图文识别API_内容检测API文档_阿里绿网-阿里云
删除快照__快照_用户指南_云服务器 ECS-阿里云
相关内容
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云