获取Kafka协议消费信息

最近更新时间: 2026-10-10 00:14:47

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.com。

获取Kafka协议消费信息

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

接口更新时间：2025-03-27 15:57:09。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeKafkaConsumer
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
FromTopicId	是	否	String	CLS对应topic标识示例值： 57f5808c-4a55-11eb-b378-0242ac130002

3. 输出参数

参数名称	类型	描述
Status	Bool	Kafka协议消费打开状态，true表示消费打开，false表示消费关闭示例值： false
TopicID	String	KafkaConsumer 消费时使用的Topic参数示例值： out-a5ce0c9c-0690-44a5-bc79-5f2190626bd0
Compression	Int64	压缩方式[0:NONE；2:SNAPPY；3:LZ4] 示例值： 2
ConsumerContent	KafkaConsumerContent	kafka协议消费数据格式示例值：查看
HasServicesLog	Uint64	是否开启投递服务日志。1：关闭，2：开启。示例值： 1
ProtocolType	Uint64	协议类型，支持 0,1, 默认 0 0: ckafka版本 1: 历史数据版本示例值： 0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 获取Kakfa协议消费信息

输入示例

POST / HTTP/1.1
Host: cls.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeKafkaConsumer
<Common Parameters>

{
    "FromTopicId": "a5ce0c9c-0690-44a5-bc79-5f2190626bd0"
}

输出示例

 {
        "Response": {
            "Status": true,
            "TopicID": "125407-ad2155c6-4a0d-45b5-83c9-8b42b6f59fbd",
            "Compression": 2,
            "ConsumerContent": {
                "Format": 1,
                "MetaFields": [
                    "__SOURCE__",
                    "__FILENAME__",
                    "__TIMESTAMP__",
                    "__HOSTNAME__",
                    "__PKGID__"
                ],
                "EnableTag": true,
                "JsonType": 1,
                "TagTransaction": 1
            },
            "RequestId": "ddfd4a0d-4ef3-43fd-b1cf-4f4a0b944d26"
        }
    }