文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>日志服务>Kafka协议消费相关接口>获取Kafka协议消费组详情

获取Kafka协议消费组详情

最近更新时间：2025-09-12 01:42:23

我的收藏

本页目录：

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

获取Kafka协议消费组详情

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeKafkaConsumerGroupDetail。
Version 是 String 公共参数，本接口取值：2020-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
TopicId 是 String 日志主题id。
- 通过获取日志主题列表获取日志主题Id。
示例值：57f5808c-4a55-11eb-b378-0242ac130002
Group 是 String 消费组名称
示例值：消费组1

3. 输出参数

参数名称 类型 描述
LogsetId String 日志集id
示例值：57f5808c-4a55-11eb-b378-0242ac130223
Group String 消费组名称
示例值：消费组1
PartitionInfos Array of GroupPartitionInfo 消费组信息列表
State String Empty：组内没有成员，但存在已提交的偏移量。所有消费者都离开但保留了偏移量
Dead：组内没有成员，且没有已提交的偏移量。组被删除或长时间无活动
Stable：组内成员正常消费，分区分配平衡。正常运行状态
PreparingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开
CompletingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开
示例值：Empty
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Kafka协议消费组详情

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKafkaConsumerGroupDetail
<公共请求参数>

{
    "TopicId": "5023192e-1254139626",
    "Group": "same_group_id"
}

输出示例

{
    "Response": {
        "Group": "same_group_id",
        "LogsetId": "a8248746-c989-468e-b931-a9bf6c999c89",
        "PartitionInfos": [
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 0
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 1
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 2
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 3
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 4
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 5
            },
            {
                "CommitTimestamp": 3223609680,
                "Consumer": "",
                "PartitionId": 6
            }
        ],
        "RequestId": "b4a11979-760c-42e2-92b8-5945eb93ee98",
        "State": "Empty"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.ACLFailed ACL校验失败。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。
中国站
目录