获取所有订阅信息_订阅管理接口_管控类 API 参考

OnsSubscribeList 接口用于获取用户所有的 CID 信息的列表。

使用场景

OnsSubscribeList 接口一般用于用户 CID 资源的列表展示，并不用于具体的信息查询。

请求参数列表

名称	类型	是否必须	描述
OnsRegionId	String	是	设置所要查询的区域，具体值通过 OnsRegionList 接口获取
OnsPlatform	String	否	该请求来源，默认是从 POP 平台
PreventCache	Long	是	用于 CSRF 校验，设置为系统当前时间即可

返回参数列表

名称	类型	描述
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	最后更新时间

使用示例

本示例查询 daily 区域下所有的 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);
         OnsSubscriptionListRequest request = new OnsSubscriptionListRequest();
            /**
            *ONSRegionId 是指你需要 API 访问 MQ 哪个区域的资源.
            *该值必须要根据 OnsRegionList 方法获取的列表来选择和配置，因为 OnsRegionId 是变动的，不能够写固定值
            */
         request.setOnsRegionId("daily");
         request.setPreventCache(System.currentTimeMillis());
         request.setAcceptFormat(FormatType.JSON);
         try {
             OnsSubscriptionListResponse response=iAcsClient.getAcsResponse(request);
             List<OnsSubscriptionListResponse.SubscribeInfoDo> subscribeInfoDoList=response.getData();
             for(OnsSubscriptionListResponse.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();
         }
     }

获取所有订阅信息

使用场景

请求参数列表

返回参数列表

相关 API

使用示例