文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V1/ 实例使用类接口/ 重置消费组消费进度到指定位置
更新时间：2024-01-30 GMT+08:00
查看PDF
分享

重置消费组消费进度到指定位置

当前页面API为历史版本API，未来可能停止维护。请使用重置消费组消费进度到指定位置。

前提条件

Kafka实例不支持在线重置消费进度。在执行重置消费进度之前，必须停止被重置消费组客户端。

在停止被重置消费组客户端后，需要经过ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG配置的时间（默认10000毫秒），服务端才认为消费组客户端真正下线。

URI

POST /v1.0/{project_id}/instances/{instance_id}/manage/groups/{group}/reset-message-offset

表1 参数说明

参数

类型

必选

说明

project_id

String

是

项目ID。

instance_id

String

是

实例ID。

group

String

是

消费组名称。

请求消息

请求参数

表2 参数说明

参数

类型

必选

说明

topic

String

是

topic名称。

partition

Integer

否

分区编号，默认值为-1，若传入值为-1，则重置所有分区。

message_offset

Long

二者必选其一

重置的消费进度到指定偏移量，如果传入offset小于当前最小的offset，则重置到最小的offset，如果大于最大的offset，则重置到最大的offset。

timestamp

Long

重置的消费进度到指定时间，格式为unix时间戳。如果传入timestamp早于当前最早的timestamp，则重置到最早的timestamp，如果晚于最晚的timestamp，则重置到最晚的timestamp。

请求示例1

{
    "topic": "test",
    "partition": 0,
    "message_offset": 10
}

请求示例2

{
    "topic": "test",
    "partition": 0,
    "timestamp": 1571812144
}

响应消息

响应参数

无

响应示例

无

状态码

操作成功的状态码。

表3 状态码

状态码

描述

204

重置消费组消息进度到指定位置操作成功。
父主题： 实例使用类接口

相关文档