文档中心

消息队列 Kafka版

Group 管理

CreateGroup - 创建Group

CreateGroup - 创建Group

调用 CreateGroup 接口创建 Group 。

使用说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Action string 必选示例值：CreateGroup

要执行的操作，取值：CreateGroup。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

Tags object[] 可选示例值：--

云资源标签。可以将 Group 通过标签进行归类，便于 Group 的识别和管理。

标签设置规则请参见标签设置规则。

Key string 必选示例值：test-key

标签的键。

Value string 必选示例值：test-value

标签的值。

InstanceId string 必选示例值：kafka-cnngbnntswg1****

实例 ID。

GroupId string 必选示例值：my_group

待创建的消费组 ID。

长度为 3～128 个字符。

只能包含大小写字母、数字、连字符（-）、特殊字符(@)和下划线(_)。

至少包含一个字母或数字。

Description string 可选示例值：测试

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

返回参数

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

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
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.	内部错误，请稍后重试。

最近更新时间：2025.08.08 17:47:28

这个页面对您有帮助吗？

有用

有用

无用

无用