获取订阅列表

最近更新时间：2019-08-13 12:04:57

前往 GitHub 编辑 我的收藏

本页目录：

接口描述

本接口 (ListSubscriptionByTopic) 该接口用于列出用户某主题下的订阅列表，可分页获取数据。

外网接口请求域名：https://cmq-topic-{$region}.api.qcloud.com
内网接口请求域名：http://cmq-topic-{$region}.api.tencentyun.com

上述域名中的{$region}需用具体地域替换：gz（广州），sh（上海），bj（北京），shjr（上海金融），szjr（深圳金融），hk（中国香港），cd（成都），ca(北美)，usw（美西），sg（新加坡）。公共参数中的 region 值要与域名的 region 值保持一致，如果出现不一致的情况，以域名的 region 值为准，将请求发往域名 region 所指定的地域。

注意：

任何时候（包括内测期间），如果使用外网域名产生公网下行流量，都会收取流量费用。所以强烈建议服务在腾讯云上的用户使用内网域名，内网不会产生流量费用。

输入参数

以下请求参数列表仅列出了接口请求参数，其它参数见公共请求参数页面。

参数名称	是否必选	类型	描述
topicName	是	String	主题名字，在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
searchWord	否	String	用于过滤订阅列表，后台用模糊匹配的方式来返回符合条件的订阅列表。如果不填该参数，默认返回帐号下的所有订阅。
offset	否	Int	分页时本页获取订阅列表的起始位置。如果填写了该值，必须也要填写 limit。该值缺省时，后台取默认值0。取值范围0 - 1000。
limit	否	Int	分页时本页获取订阅的个数，该参数取值范围0 - 100。如果不传递该参数，则该参数默认为20。

说明：

offset、limit 的含义与 SQL 的 offset 和 limit 一致。

输出参数

参数名称	类型	描述
code	Int	请参考错误码
message	String	错误提示信息。
requestId	String	服务器生成的请求 ID。出现服务器内部错误时，用户可提交此 ID 给后台定位问题。
totalCount	Int	用户帐号下本次请求返回的主题总数，而非分页后本页获取的主题数量。
subscriptionList	Array	主题列表信息，每个元素表示一个主题的信息。

subscriptionList 定义如下：

参数名称	类型	描述
subscriptionId	String	订阅 ID。订阅 ID 在拉取监控数据时会用到。
subscriptionName	String	订阅名字，在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
protocol	String	订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
endpoint	String	接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以`http://`开头，host 可以是域名或 IP；对于 queue，则填 queueName。

示例

输入：

 https://domain/v2/index.php?Action=ListSubscriptionByTopic
 &searchWord=abc
 &<公共请求参数>

输出：

{
    "code":0,
    "message":"",
    "requestId":"14534664555",
    "totalCount":2,
    "subscriptionList":[
        {
            "subscriptionId":"subsc-sdkfl",
            "subscriptionName":"test-sub2",
            "protocol":"http",
            "endpoint":"http://testhost/testpath"
        },
        {
            "subscriptionId":"subsc-34lasdk",
            "subscriptionName":"test-sub1",
            "protocol":"queue",
            "endpoint":"test-queue-name"
        }
    ]
}

下一篇: 更新历史