文档中心

消息队列 Kafka版

Group 管理

ResetConsumedOffsets - 重置消费位点

调用 ResetConsumedOffsets 重置消费者组的消费位点。

使用说明

此接口用于重置指定消费组的消费位点，改变订阅者当前的消费位置，即直接从某个指定时间点、最新 offset 位点或指定 offset 位点来消费消息。

说明

消息队列 Kafka版不支持在线重置消费位点，在重置消费位点之前，必须停止 Consumer Group 中的所有消费者客户端，确保 Group 的状态为 Empty。

停止消费者客户端后，需要经过指定的超时时间，服务端才认为 Consumer 真正下线。其中超时时间为 ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG 配置的时间，默认 10000ms。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ResetConsumedOffsets

要执行的操作，取值：ResetConsumedOffsets。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

InstanceId string 必选示例值：kafka-cnngbnntswg1****

需要重置消费位点的实例 ID。

GroupId string 必选示例值：my_group

需要重置消费位点的消费组 ID。

ResetOffsetsInfo object[] 必选示例值：--

需要重置的消费位点信息。

PartitionId integer 可选示例值：3

需要重置消费位点的分区编号。

不指定 PartitionId 时，重置指定 Topic 下的所有分区。

当 TopicName 指定为 * 时，不支持设置 PartitionId。

ResetType string 可选示例值：Offset

消费位点重置的方式，默认为 Offset。可设置为：

Offset：（默认）根据指定 offset 重置消费位点，即 Group 在当前分区中从指定位点开始消费。此时默认重置到最新的 Offset，也可以通过参数 ResetOffset 指定 Offset。

Timestamp：根据指定时间重置消费位点，即从过去的某个指定时段内选择一个时间点开始消费。此时需要通过参数 ResetTimestamp 设置时间点。

TopicName string 必选示例值：my_topic

Topic 名称。

当参数值指定为“*”时，表示重置 Group 消费的所有分区。

ResetTimestamp long 可选示例值：1677502758825

重置消费位点到指定的时间点。时间戳格式，单位为毫秒。仅在 ResetType 为 Timestamp 时需要设置。

消费时间戳为消息存储到服务端的时间。

可重置的时间点范围由 Topic 的消息保留时间决定，即此参数的取值范围为 [当前时间-实例消息保留时长, 当前时间]。

若指定时间不存在消息，则会重置到最近的消息位置。

ResetOffset long 可选示例值：-2

重置消费位点到指定 Offset。仅在 ResetType 为 Offset 时需要设置。未指定此参数时，表示重置到最新的消息位置。

取值范围：

-1：（默认）将消费位点重置到最新的一条消息。

-2：将消费位点重置到最早的一条消息。

其他整型数值：指定重置消费位点到指定 Topic 的指定分区中某个具体的 Offset 位置，取值范围为分区的最小 Offset 和最大 Offset 之间，即 [StartOffset,EndOffset]。

说明

仅在指定 TopicName 和 PartitionId 时，可以将 ResetOffset 指定为其他整型数值。

您可以通过 DescribeTopicPartitions 查看 StartOffset 和 EndOffset。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.GroupNotEmpty	The group is not empty.	Group 不为空。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidGroupId.NotFound	The specified consumer group does not exist.	Group 不存在。
404	InvalidTopicName.NotFound	The specified topic does not exist.	Topic 不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。

最近更新时间：2025.08.08 17:47:28

这个页面对您有帮助吗？

有用

无用