Deleting a Kafka Message

Updated on 2025-03-07 GMT+08:00

View PDF

This API is used to delete a Kafka message.

For details, see Calling APIs.

DELETE /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/messages

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
topic	Yes	String	Topic name.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
partitions	No	Array of PartitionOffsetEntity objects	Partition offset details.

**Table 3** PartitionOffsetEntity
Parameter	Mandatory	Type	Description
partition	No	Integer	Partition.
offset	No	Integer	Consumer offset.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
partitions	Array of PartitionResp objects	Partition response information.

DELETE https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/messages

Status code: 200

Successful

{
  "partitions" : [ {
    "partition" : 0,
    "result" : "success",
    "error_code" : 0
  } ]
}

Status Code	Description
200	Successful

Parent Topic: Managing Messages

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel