获取 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-阿里云