CreateGroup--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

消息队列 RocketMQ版

CreateGroup

最近更新时间：2024.03.06 16:49:21首次发布时间：2021.08.30 16:57:44

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

注意事项

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	MQ_INST_********	实例 ID。
GroupId	String	必选	GID-123	Group 的 ID。长度限制为 7~64 个字符，只能包含字母、数字、短划线（-）和下划线（_）。必须以“GID-”或“GID_”开头。创建 Group 后无法修改ID，请谨慎设置。
Description	String	必选	test	Group 的简单描述。长度限制为 0~128 个字符。
ProtocalType	String	必选	TCP	Group 适用的协议。目前仅支持设置为`TCP`，表示此 Group 仅适用于 TCP 协议的消息收发。

响应参数

无

示例

请求示例

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

{
  "InstanceId": "MQ_INST_********",
  "GroupId": "GID-123",
  "Description": "new",
  "ProtocalType": "TCP"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "*********************",
    "Action": "CreateGroup",
    "Version": "2021-04-01",
    "Service": "rocketmq",
    "Region": "cn-beijing"
  },
  "Result": null
}