文档中心

CreateGroup

最近更新时间：2024.03.07 20:25:47

首次发布时间：2023.09.27 10:17:50

调用 CreateGroup 创建消费组（ConsumerGroup）。
使用说明
此接口用于在指定实例下创建一个 Kafka 的消费组，您可使用该消费组进行消息订阅。
请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	kafka-cnngbnntswg1****	实例 ID。
GroupId	String	是	my_group	待创建的消费组 ID。长度为 3～128 个字符。只能包含大小写字母、数字、连字符（-）、特殊字符(@)和下划线(_)。至少包含一个字母或数字。
Description	String	否	测试	消费组描述信息。长度不超过 128 个字符。
Tags	Array of TagObject	否	[{"Key":"keyA","Value":"valueA"}]	云资源标签。可以将 Group 通过标签进行归类，便于 Group 的识别和管理。标签设置规则请参见标签设置规则。

响应参数
无
示例
请求示例

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

{
  "InstanceId": "kafka-cnoerum8**",
  "GroupId": "group-d",
  "Description": "test",
  "Tags": [
    {
      "Key": "user",
      "Value": "a"
    },
    {
      "Key": "doc",
      "Value": "test"
    }
  ]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023022719194098F0DF73611FD95FA1A2",
        "Action": "CreateGroup",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

消息队列 Kafka版

CreateGroup