Docs

Message Queue for Kafka

Group management

DeleteGroup - Delete Group

Call DeleteGroup to delete the consumer group (ConsumerGroup).

Instructions

This API deletes the consumer group under the instance. Deletion is irreversible. Use with caution.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: DeleteGroup

The action to perform, value: DeleteGroup.

Version string required Example value: 2022-05-01

API version, value: 2022-05-01.

InstanceId string required Example value: kafka-cnngbnntswg1****

The instance ID of the consumer group to be deleted.

GroupId string required Example: my_group

ID of the consumer group to delete.

Response parameters

This interface has no unique response parameters. For more information, see the response structure.

Request example

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"​
}​

Response example

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

Error code

The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	Specifications
400	InvalidParameter	The specified parameter is not valid.	Invalid parameter value.
403	OperationDenied.GroupNotEmpty	The group that you tried to delete is not empty.	The group to delete must not be empty.
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	You are not authorized. Authorize or switch accounts and try again.
404	InvalidGroupId.NotFound	The specified consumer group does not exist.	Group does not exist.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.

Last updated: 2025.06.30 12:00:30