You need to enable JavaScript to run this app.
导航
DeleteGroup - 删除 Group
最近更新时间:2024.09.26 15:55:18首次发布时间:2023.03.30 19:59:26

调用 DeleteGroup 删除消费组(ConsumerGroup)。

使用说明

本接口会删除实例下的消费组,删除后不可恢复,请谨慎调用。

调试

请求参数

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

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

DeleteGroup

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

Version
String

2022-05-01

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

InstanceId
String

kafka-cnngbnntswg1****

待删除消费组所属的实例 ID。

GroupId
String

my_group

待删除的消费组 ID。

返回参数

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

请求示例

POST /?Action=DeleteGroup&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-cnngbnntswg1****",
  "GroupId": "Group"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202302272036532B034FE726F55372A619",
        "Action": "DeleteGroup",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

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

参数值无效。

403
OperationDenied.GroupNotEmpty
The group that you tried to delete is not empty.

期望删除的Group不为空。

403
OperationDenied.AccountNotAuthorized
You are not authorized to perform this operation.

您不具备相关权限 ,请授权或切换账号后重试。

404
InvalidGroupId.NotFound
The specified consumer group does not exist.

Group不存在。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。