文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 消息管理/ 删除Kafka消息 - DeleteKafkaTopicMessages
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除Kafka消息 - DeleteKafkaTopicMessages

功能介绍

删除Kafka消息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/messages/delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

topic

是

String

Topic名称。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

partitions

否

Array of PartitionOffsetEntity objects

分区消费位点详情
表3 PartitionOffsetEntity

参数

是否必选

参数类型

描述

partition

否

Integer

分区

offset

否

Integer

消费位点

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

partitions

Array of PartitionResp objects

分区响应信息
表5 PartitionResp

参数

参数类型

描述

partition

Integer

分区

result

String

返回结果

error_code

String

返回错误码

请求示例

删除Kafka消息。

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

{
  "partitions" : [ {
    "partition" : 0,
    "offset" : 1
  } ]
}

响应示例

状态码：200

删除消息成功。

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

状态码

状态码

描述

200

删除消息成功。

错误码

请参见错误码。

父主题： 消息管理

相关文档