获取主题列表

最近更新时间:2019-08-13 12:11:43

接口描述

本接口 (ListTopic) 该接口用于列出用户账户下的主题列表,可分页获取数据。

  • 外网接口请求域名: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 所指定的地域。

注意:

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

输入参数

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

参数名称 是否必选 类型 描述
searchWord String 用于过滤主题列表,后台用模糊匹配的方式来返回符合条件的主题列表。如果不填该参数,默认返回帐号下的所有主题
offset Int 分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值0
limit Int 分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50
说明:

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

输出参数

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

topicList 定义如下:

参数名称 类型 描述
topicId String 主题的唯一标识 ID
topicName String 主题名字,在单个地域同个帐号下唯一。 主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线-

示例

输入:

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

输出:

{
    "code": 0,
    "message": "",
    "requestId": "14534664555",
    "totalCount": 10,
    "topicList": [{
            "topicId": "topic-asdfo",
            "topicName": "test-topic1"
        },
        {
            "topicId": "topic-asdsafo",
            "topicName": "topic-test1"
        }
    ]
}