521
人物
查询指定 Topic 状态__Topic 相关接口_Open API_消息队列 MQ-阿里云
查询 Topic
本文介绍 OnsTopicGet 接口,用于查询指定 Topic 的信息,属于精确查询。
1. 使用场景
查询账号下指定 Topic 的分布情况,并获取 Topic 当前的开通状态和权限关系等信息。由于是精确查询,因此输入参数必须包含 Topic 名称。
2. 请求参数列表
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| OnsRegionId | String | 是 | 当前查询 MQ 所在区域,可以通过 ONSRegionList 方法获取,参见公共术语 |
| OnsPlatform | String | 否 | 该请求来源,默认是从 POP 平台 |
| PreventCache | Long | 是 | 用于 CSRF 校验,设置为系统当前时间即可 |
| Topic | String | 是 | 指定查询的 Topic |
3. 返回参数列表
| 名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 为公共参数,每个请求独一无二 |
| HelpUrl | String | 帮助链接 |
| Data | List(PublishInfoDo) | 返回所有已发布的 Topic 信息列表 |
PublishInfoDo 数据结构
| 成员 | 类型 | 描述 |
|---|---|---|
| id | Long | 该 Topic 信息编号 |
| channelId | Integer | 该 Topic 所在区域 ID,0代表阿里云,1代表聚石塔 |
| channelName | String | 该 Topic 所在类别,阿里云,或者聚石塔,… |
| 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接入点接入,查询名为”MingduanTest”的 Topic,并打印 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);OnsTopicGetRequest request = new OnsTopicGetRequest();request.setAcceptFormat(FormatType.JSON);request.setTopic("MingduanTest");/***ONSRegionId是指需要API访问MQ哪个区域的资源.*该值必须要根据OnsRegionList方法获取的列表来选择和配置,因为OnsRegionId是变动的,不能够写固定值*/request.setOnsRegionId("daily");request.setPreventCache(System.currentTimeMillis());try {OnsTopicGetResponse response = IAcsClient.getAcsResponse(request);List<OnsTopicGetResponse.PublishInfoDo> publishInfoDoList=response.getData();for (OnsTopicGetResponse.PublishInfoDo publishInfoDo:publishInfoDoList){System.out.println(publishInfoDo.getId()+" "+publishInfoDo.getChannelId()+" "+publishInfoDo.getChannelName()+" "+publishInfoDo.getOnsRegionId()+" "+publishInfoDo.getRegionName()+" "+publishInfoDo.getTopic()+" "+publishInfoDo.getOwner()+" "+publishInfoDo.getRelation()+" "+publishInfoDo.getRelationName()+" "+publishInfoDo.getStatus()+" "+publishInfoDo.getStatusName()+" "+publishInfoDo.getAppkey()+" "+publishInfoDo.getCreateTime()+" "+publishInfoDo.getUpdateTime()+" "+publishInfoDo.getRemark());}System.out.println(response.getRequestId());}catch (ServerException e) {e.printStackTrace();}catch (ClientException e) {e.printStackTrace();}catch (Exception e) {e.printStackTrace();}}
最后更新:2016-12-19 14:53:12
上一篇:
获取 Topic 列表__Topic 相关接口_Open API_消息队列 MQ-阿里云
下一篇:
搜索指定 Topic 详细信息__Topic 相关接口_Open API_消息队列 MQ-阿里云
极高性价比 阿里云重磅推出PolarDB云数据库
云服务器 ECS 云服务器宕机排查
导入PostgreSQL数据__快速入门_云数据库 HybridDB-阿里云
前言 极速自由的大数据OLAP体验__使用手册_分析型数据库-阿里云
概览页介绍__用户指南_企业级分布式应用服务 EDAS-阿里云
数量限制__使用须知_用户指南_弹性伸缩-阿里云
运行SQL__快速开始_大数据计算服务-阿里云
挂载文件系统__快速入门_文件存储-阿里云
VirtualBorderRouterType__数据类型_API 参考_云服务器 ECS-阿里云
配置ECS安全组只放行高防回源IP段__运维问题_产品常见问题_DDoS 高防IP-阿里云
相关内容
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云