文档中心

日志服务

请输入

消费组管理

DescribeConsumerGroups

调用 DescribeConsumerGroups 接口获取一个日志项目下的所有消费组信息。

使用说明

请求说明

请求参数

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

Query

返回参数

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

参数	类型	示例值	描述
ConsumerGroups	Array of ConsumerGroupResp	{ "ConsumerGroups": [ { "ProjectID": "32********", "ConsumerGroupName": "test-consumer-group", "HeartbeatTTL": 60, "OrderedConsume": false } ] }	日志服务消费组列表。
Total	Integer	1	消费组总数。

ConsumerGroupResp

参数	类型	示例值	描述
topic_id	Array of String	c7******	消费组订阅的日志主题列表。
ProjectID	String	c7******	消费组订阅的日志项目 ID。
ProjectName	String	test	消费组订阅的日志项目名称。
HeartbeatTTL	Integer	60	心跳过期时间，单位为秒。
OrderedConsume	Boolean	false	是否按顺序消费。 true：在 Shard 中按顺序消费。Shard 分裂后，先消费完原 Shard 数据，然后并行消费由该 Shard 分裂出的 Shard 数据；Shard 合并后，先消费完原 Shard 数据，然后消费由原 Shard 合并后的新 Shard 数据。 false：不按顺序消费。即所有 Shard 同时消费，Shard 分裂或者合并后产生的新 Shard，也会立即消费。
ConsumerGroupName	String	my-consumer-group	消费组名称。

请求示例

返回示例

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

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

这个页面对您有帮助吗？

有用

无用