You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /
  • 消息队列 RocketMQ版

CreateGroup

最近更新时间：2024.03.06 16:49:22

首次发布时间：2023.07.12 16:22:34

我的收藏

调用 CreateGroup 创建一个新的消费组（Group）。

注意事项

请求频率：该接口请求频率限制为 20 次/秒；单用户请求频率限制为 4 次/秒。

使用说明

在消息队列 RocketMQ版中，您需要创建 Group，并通过 Group ID 标识不同类别的生产者或消费者。

  • 每个实例的 Topic 数量配额与实例规格有关，例如各个规格实例可创建的 Topic 数量请参考产品规格。
  • 消费者必须配置 Group ID，生产者可以忽略 Group ID 配置。
  • 目前支持的客户端协议为 TCP。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-****

实例 ID。

GroupId

String

是

my_group

Group 的 ID。

  • 长度限制为 7~120 个字符，只能包含字母、数字、短划线（-）和下划线（_）。
  • 推荐以 GID- 或 GID_ 开头。

创建 Group 后无法修改 ID，请谨慎设置。
对于2023年6月5日及之前创建的 RocketMQ 实例，Group 名称不可超过 93 个字符。禁用词列表请参考创建 Group。

GroupType

String

是

TCP

Group 的协议标识，用于备注该 Group 的生产消费协议类型。可指定为 TCP。

Description

String

否

test

Group 的简单描述。

响应参数

无

示例

请求示例

POST /?Action=CreateGroup&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "GroupId": "GID_test123",
  "GroupType": "TCP"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202305082005189BF891554A576C48F3B0",
        "Action": "CreateGroup",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": null
}