文档首页/ 分布式消息服务RocketMQ版/ API参考（联盟区域）/ API V2（推荐）/ 消费组管理/ 创建消费组或批量删除消费组
更新时间：2026-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建消费组或批量删除消费组

功能介绍

创建消费组或批量删除消费组。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

action

否

String

参数解释：

批量删除消费组时使用，不配置则为创建接口。

约束限制：

不涉及。

取值范围：

  • delete：删除。

默认取值：

不涉及。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

groups

否

Array of DeleteConsumerGroupInBatch objects

参数解释：

需要删除的消费组列表。

约束限制：

当批量删除消费组时必填。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

消费组名称。

约束限制：

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

当创建消费组时必填。

取值范围：

不涉及。

默认取值：

不涉及。

brokers

否

Array of strings

参数解释：

关联的代理列表。

约束限制：

仅RocketMQ实例4.8.0版本创建消费组时需要填写此参数。

取值范围：

不涉及。

默认取值：

不涉及。

broadcast

否

Boolean

参数解释：

是否设置为广播消费。创建消费组时填写此参数。

约束限制：

不涉及。

取值范围：

  • true：使用广播消费。

  • false：不使用广播消费。

默认取值：

不涉及。

retry_max_time

否

Integer

参数解释：

最大重试次数。创建消费组时填写此参数。

约束限制：

不涉及。

取值范围：

1~16。

默认取值：

不涉及。

enabled

否

Boolean

参数解释：

是否可以消费。创建消费组时填写此参数。

约束限制：

不涉及。

取值范围：

  • true：可以消费。

  • false：不可以消费。

默认取值：

不涉及。

consume_orderly

否

Boolean

参数解释：

是否按顺序消费。

约束限制：

仅RocketMQ实例5.x版本需要填写此参数。创建消费组时填写此参数。

取值范围：

  • true：顺序消费。

  • false：不按顺序消费。

默认取值：

不涉及。

group_desc

否

String

参数解释：

消费组描述。创建消费组时填写此参数。

约束限制：

不涉及。

取值范围：

0~200。

默认取值：

不涉及。
表4 DeleteConsumerGroupInBatch

参数

是否必选

参数类型

描述

name

否

String

参数解释：

消费组名称。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

删除消费组的任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

创建成功的消费组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

  • 4.8.0版本RocketMQ实例创建一个消费组，不允许以广播模式消费，关联代理为broker-0，最大重试次数为16。

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

{
  "name" : "consumer-group-test",
  "group_desc" : "group_description",
  "brokers" : [ "broker-0" ],
  "broadcast" : false,
  "retry_max_time" : 16
}

  • 删除消费组consumer-group-test。

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?action=delete

{
  "groups" : [ "group-1", "group-2" ]
}

响应示例

状态码：200

创建消费组或批量删除消费组成功。

  • 创建消费组。

    {
  "name" : "consumer-group-test"
}

  • 批量删除消费组成功。

    {
  "job_id" : "ff8080829ae99a23019b240d388b4e47"
}

状态码

状态码

描述

200

创建消费组或批量删除消费组成功。

错误码

请参见错误码。

父主题： 消费组管理