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

查询消费分组信息(精简版)

最近更新时间:2019-06-25 23:44:49
我的收藏

1. 接口描述

本接口 (ListGroup) 用于在用户账户下获取 CKafka 消费分组信息,该接口为精简版接口,返回消费分组信息较少,可以调用 GetGroupInfo 查询消费分组详细信息。
接口请求域名:ckafka.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称
是否必选
类型
描述
instanceId
否
String
(过滤条件)按照实例 ID 过滤。
group
否
String
消费分组(精确匹配)。
searchWord
否
String
模糊匹配 group。
offset
否
Int
偏移量,不填默认为 0。
limit
否
Int
返回数量,不填则默认 20,最大值 50。

3. 输出参数

参数名称
类型
描述
totalCount
Int
符合条件的消费分组个数。
groupList
JSON Array Object
消费分组详情,含义可以参考示例输出参数说明。
groupList::group
String
groupId。
groupList::protocol
String
该 group 使用的协议。

4. 示例

输入:
https://domain/v2/index.php?Action=ListGroup&<公共请求参数>
输出:
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"totalCount": 1, // 符合本次搜索的所有 group 个数
"groupList": [
{
"group": "mirror_vpc_forward",// groupId
"protocol": "consumer" // 该 group 使用的协议
}
]
}
}