ResetConsumedOffsets - 重置消费位点--消息队列 RocketMQ版-火山引擎

文档中心

导航

ResetConsumedOffsets - 重置消费位点

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

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

使用说明

在清除堆积消息、离线数据处理等场景下，需要消费过去某个时段的消息，或清除所有堆积消息，可以对消费位点进行重置操作。此接口用于重置消费位点，即改变订阅者当前的消费位置，直接从最新 Offset 位点或某个指定时间点来消费消息。
关于重置消费位点的注意事项与支持的重置方式，请参考重置消费位点。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ResetConsumedOffsets	要执行的操作，取值：ResetConsumedOffsets。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
GroupId	String	是	GID_test	Group ID。
TopicName	String	是	my_topic	Topic 名称。当字段值指定为星号（*）时，表示重置该消费组消费的所有 Topic。
ResetType	String	否	EndOffset	消费位点重置的方式，可设置为： EndOffset：默认值，将消费位点重置到最新的一条消息。该 Group 在消费该 Topic 下的消息时会跳过当前堆积（未被消费）的所有消息，从在此之后的最新消息开始消费。 Timestamp：指定时间进行消费重置。
ResetTimestamp	Long	否	1683545537	仅适用于 ResetType 为 Timestamp 时。消费时间戳为消息存储到服务端的时间，单位秒级。取值范围：[当前时间-实例消息保留时长, 当前时间] 若指定时间不存在消息，则会重置到最近的消息位置。

返回参数

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

请求示例

POST /?Action=ResetConsumedOffsets&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********


{
  "InstanceId": "rocketmq-cnai81fd122a****",
  "GroupId": "GID_test",
  "TopicName": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305082027328030FB77162129494093",
        "Action": "ResetConsumedOffsets",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {}
}

错误码

公共错误码请参见公共错误码文档。