文档中心

日志服务

请输入

消费组管理

ModifyConsumerGroup

调用 ModifyConsumerGroup 接口修改日志服务消费组的配置。

使用说明

本接口用于修改日志服务消费组订阅的日志主题 ID 列表、心跳过期时间等配置，不支持修改消费组名称。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

请求参数

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

Body

参数	类型	是否必选	示例值	描述
ConsumerGroupName	String	是	my-consumer-group	待修改配置的消费组名称。
HeartbeatTTL	Integer	否	60	心跳过期时间，单位为秒，取值范围为 1~300。
OrderedConsume	Boolean	否	false	是否按顺序消费。 true：在 Shard 中按顺序消费。Shard 分裂后，先消费完原 Shard 数据，然后并行消费由该 Shard 分裂出的 Shard 数据；Shard 合并后，先消费完原 Shard 数据，然后消费由原 Shard 合并后的新 Shard 数据。 false：不按顺序消费。即所有 Shard 同时消费，Shard 分裂或者合并后产生的新 Shard，也会立即消费。
ProjectID	String	是	c7******	消费组所属的日志项目的 ID。
TopicIDList	Array of String	否	["a1****", "b2****"]	消费组待消费的日志主题 ID 列表。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

返回示例

错误码

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

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

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

这个页面对您有帮助吗？

有用

无用