文档首页> 分布式消息服务RocketMQ版> API参考（阿布扎比区域）> API V2（推荐）> 消费组管理> 修改消费组
更新时间：2023-05-06 GMT+08:00
查看PDF

修改消费组

功能介绍

修改指定消费组参数。

URI

PUT /v2/{project_id}/instances/{instance_id}/groups/{group}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

instance_id

是

String

实例ID。

group

是

String

消费组名称。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enabled

否

Boolean

是否可以消费。

broadcast

否

Boolean

是否广播。

brokers

否

Array of strings

关联的代理列表。

name

否

String

消费组名称。

retry_max_time

否

Number

最大重试次数。

from_beginning

否

Boolean

是否重头消费。

响应参数

无

请求示例

修改消费组。

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}

{
  "name" : "consumer-group-test",
  "enabled" : true,
  "retry_max_time" : 16,
  "from_beginning" : true,
  "broadcast" : true
}

响应示例

无

状态码

状态码

描述

204

操作成功。

错误码

请参见错误码。

父主题： 消费组管理