查询消费分组信息

最近更新时间:2019-04-26 13:25:53

1. 接口描述

本接口(ListConsumerGroup)用于在用户账户下获取 CKafka 消费分组信息。

接口请求域名:ckafka.api.qcloud.com

2. 输入参数

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

参数名称 是否必选 类型 描述
instanceId String (过滤条件)按照实例 ID 过滤
groupName String 消费分组名称(精确匹配)
topicName String 主题名称,若不填 groupName,则该参数会被忽略
offset Int 偏移量,不填默认为0
limit Int 返回数量,不填则默认50,最大值50

3. 输出参数

参数名称 类型 描述
totalCount Int 符合本次搜索的消费分组个数
groupList json array object 消费分组详情,含义可以参考示例输出参数说明

4. 示例

输入:

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

输出:

  {
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalCount": 1,// 符合本次搜索的消费分组个数
        "topicList": {
            "tes": "topic-4imuy62g"
        },
        "groupList": { // 消费分组List
            "console-consumer-24193": { // 消费分组名称
                "tes": [ // key为该消费分组订阅的主题名称  数组表示该消费分组在该主题下面每个分区的消费进度offset。
                    10,
                    12,
                    12,
                    12,
                    12,
                    12,
                    12,
                    11
                ]
            }
        },
        "totalPartition": 8,
        "partitionListForMonitor": [
            {
                "partitionId": 0
            },
            {
                "partitionId": 1
            },
            {
                "partitionId": 2
            },
            {
                "partitionId": 3
            },
            {
                "partitionId": 4
            },
            {
                "partitionId": 5
            },
            {
                "partitionId": 6
            },
            {
                "partitionId": 7
            }
        ],
        "totalTopic": 1,
        "topicListForMonitor": [
            {
                "topicName": "tes",
                "topicId": "topic-4imuy62g"
            }
        ],
        "groupListForMonitor": [
            {
                "groupName": "console-consumer-24193"
            }
        ]
    }
}