DeleteGroup--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

消息队列 Kafka版

DeleteGroup

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.24 15:56:38

调用 DeleteGroup 删除消费组（ConsumerGroup）。

使用说明

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

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceID	String	必选	kafka-****	待删除消费组所属的实例 ID。
ConsumerID	String	必选	my_group	待删除的消费组 ID。

响应参数

null

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DeleteGroup&Version=2018-01-01 HTTP/1.1
Accept: application/json
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-****",
  "ConsumerID": "my_group"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DeleteGroup",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": null
}