Batch Deleting Consumer Groups of a Kafka Instance

Function

This API is used to delete multiple consumer groups of a Kafka instance in batches.

URI

POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
group_ids	No	Array of strings	IDs of all consumer groups to be deleted.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
failed_groups	Array of failed_groups objects	List of consumer groups that failed to be deleted.
total	Integer	Number of records that fail to be deleted.

**Table 4** failed_groups
Parameter	Type	Description
group_id	String	ID of consumer groups that failed to be deleted.
error_message	String	Cause of the deletion failure.

Example Requests

Batch deleting consumer groups

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete

{
  "group_ids" : [ "get-sync-group0", "get-sync-group1" ]
}

Example Responses

Status code: 200

The consumer groups are deleted successfully.

{
  "failed_groups" : [ {
    "group_id" : "test-1",
    "error_message" : "UNKNOW"
  }, {
    "group_id" : "test-2",
    "error_message" : "UNKNOW"
  } ],
  "total" : 2
}