文档中心

日志服务

请输入

Kafka 协议消费

DescribeKafkaConsumer

调用 DescribeKafkaConsumer 查看指定日志主题的 Kafka 消费功能状态。

使用说明

此接口调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
TopicId	String	是	c7e0e442-19bf-4fb3-b547-5992fb8b****	日志主题的 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AllowConsume	Boolean	true	指定日志主题是否已开启了 Kafka 协议消费功能。 true：已开启。 false：未开启。
ConsumeTopic	String	out-0fdaa6b6-3c9f-424c-8664-fc0d222c****	Kafka 协议消费主题 ID，格式为 out+日志主题 ID。通过 Kafka 协议消费此日志主题中的日志数据时，Topic 应指定为此 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
404	TopicNotExist	topic %s does not exist.	日志主题不存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

最近更新时间：2025.10.14 14:20:53

这个页面对您有帮助吗？

有用

无用