获取消费分组信息

最近更新时间: 2026-09-17 00:01:30

1. 接口描述

接口请求域名： ckafka.api3.fincloud.tencent.cn。

获取消费分组信息

默认接口请求频率限制：100次/秒。

接口更新时间：2020-01-07 11:26:49。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroupInfo
Version	是	否	String	公共参数，本接口取值：2019-08-19
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	（过滤条件）按照实例 ID 过滤。示例值： ckafka-test
GroupList	是	否	Array of String	Kafka 消费分组，Consumer-group，这里是数组形式。如果使用拼接数组元素方式传值（一般 GET 请求用），可以使用格式：GroupList.0=xxx&GroupList.1=yyy。示例值： ["group-test"]

3. 输出参数

参数名称	类型	描述
Result	Array of GroupInfoResponse	返回的结果示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InvalidParameterValue.RepetitionValue	已存在相同参数。
InvalidParameterValue.WrongAction	Action参数取值错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
UnauthorizedOperation	未授权操作。
UnsupportedOperation.OssReject	Oss拒绝该操作
InvalidParameterValue.SubnetNotBelongToZone	子网不属于zone
InvalidParameterValue.VpcIdInvalid	无效的 Vpc Id
InvalidParameterValue.SubnetIdInvalid	无效的子网id
InvalidParameterValue.ZoneNotSupport	zone不支持
UnsupportedOperation.BatchDelInstanceLimit	批量删除实例限制
InternalError	内部错误。
ResourceUnavailable	资源不可用。

5. 示例

示例1 获取消费分组信息

输入示例

https://ckafka.api3.{{conf.domain_main}}/?Action=DescribeGroupInfo
&InstanceId=xxxx
&GroupList.0=xx
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": [
            {
                "ErrorCode": "0",
                "State": "Stable",
                "ProtocolType": "consumer",
                "Protocol": "range",
                "Members": [
                    {
                        "MemberId": "consumer-1-/10.53.88.65-2018-08-10 10:17:19:639-88206ef1-9248-43a0-9ff4-e22c3ab21e92",
                        "ClientId": "consumer-1",
                        "ClientHost": "/10.53.88.65",
                        "Assignment": {
                            "Version": 0,
                            "Topics": [
                                {
                                    "Topic": "test",
                                    "Partitions": [
                                        0
                                    ]
                                }
                            ]
                        }
                    }
                ],
                "Group": "perf-consumer-97910"
            }
        ],
        "RequestId": "8e9b234e-0c3e-4340-9733-adbd05879b10"
    }
}