调用 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。
|
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 | 参数值无效。 |
400 | InvalidGroupId.AlreadyExists | Group ID已存在。 |
400 | QuotaExceede.GroupNumber | Group数量超出上限。 |
500 | InternalError | 内部错误,请稍后重试。 |