文档首页/ 分布式消息服务RocketMQ版/ API参考 (巴黎区域)/ API V2（推荐）/ 消费组管理/ 批量修改消费组
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

批量修改消费组

功能介绍

批量修改消费组。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

groups

否

Array of ConsumerGroup objects

消费组列表，当批量删除消费组时使用。
表3 ConsumerGroup

参数

是否必选

参数类型

描述

enabled

否

Boolean

是否可以消费。

broadcast

否

Boolean

是否广播。

brokers

否

Array of strings

关联的代理列表。

name

否

String

消费组名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。

retry_max_time

否

Number

最大重试次数。

from_beginning

否

Boolean

是否重头消费。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

批量修改消费组的参数，将group1消费组的最大重试次数修改为16。

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

{
  "groups" : [ {
    "enabled" : true,
    "broadcast" : false,
    "brokers" : [ "broker-0" ],
    "name" : "group1",
    "retry_max_time" : 16,
    "from_beginning" : false
  } ]
}

响应示例

状态码： 200

批量修改消费组成功。

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

状态码

状态码

描述

200

批量修改消费组成功。

错误码

请参见错误码。

父主题： 消费组管理