帮你快速理解、总结文档立即下载

获取主题列表

最近更新时间:2019-10-09 11:49:19
我的收藏

1. 接口描述

接口请求域名:ckafka.api.qcloud.com 本接口(ListTopic)用于在用户获取消息队列 CKafka 实例的主题列表。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 文档。
参数名称
必选
类型
描述
instanceId
是
String
实例 ID
searchWord
否
String
(过滤条件)按照 topicName 过滤,支持模糊查询
offset
否
Int
偏移量,不填默认为0
limit
否
Int
返回数量,不填则默认为10,最大值为50

3. 输出参数

参数名称
类型
描述
totalCount
Int
符合条件的 topic 数量
topicList
Array
主题信息列表
topicList::topicId
String
主题 ID
topicList::topicName
String
主题名称
topicList::note
String
主题备注, 不设置为空字符串

4. 示例

输入:
https://domain/v2/index.php?Action=ListTopic&instanceId=ckafka-xxooa0&<公共请求参数>
输出:
{
"code": 0,
"codeDesc": "Success",
"message": "ok",
"totalCount": 10,
"topicList": [{
"topicId": "topic-xxoo234",
"topicName": "jimmy",
"note": ""
}]
}