You need to enable JavaScript to run this app.
导航
CreateGroup - 创建Group
最近更新时间:2024.10.17 15:05:28首次发布时间:2023.09.27 10:17:50

调用 CreateGroup 接口创建 Group 。

使用说明

此接口用于在指定实例下创建一个 Kafka 的消费组,您可使用该消费组进行消息订阅。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateGroup

要执行的操作,取值:CreateGroup。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

Tags
Array of Object

--

云资源标签。可以将 Group 通过标签进行归类,便于 Group 的识别和管理。
标签设置规则请参见标签设置规则

InstanceId
String

kafka-cnngbnntswg1****

实例 ID。

GroupId
String

my_group

待创建的消费组 ID。

  • 长度为 3~128 个字符。
  • 只能包含大小写字母、数字、连字符(-)、特殊字符(@)和下划线(_)。
  • 至少包含一个字母或数字。
Description
String

测试

消费组描述信息。长度不超过 128 个字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST /?Action=CreateGroup&Version=2022-05-01 HTTP/1.1
Host: kafka.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241017T065458Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241017/cn-beijing/Kafka/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Tags": [
    {
      "Key": "test-key",
      "Value": "test-value"
    }
  ],
  "InstanceId": "kafka-cnngbnntswg1****",
  "GroupId": "my_group",
  "Description": "测试"
}

返回示例

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter is not valid.

参数值无效。

400
InvalidGroupId.AlreadyExists
The specified Group ID already exists.

Group ID已存在。

400
QuotaExceede.GroupNumber
The number of groups exceeds the limit.

Group数量超出上限。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。