You need to enable JavaScript to run this app.
导航

ResetGroupOffset

最近更新时间2023.07.12 16:47:04

首次发布时间2022.04.20 19:35:25

调用 ResetGroupOffset 接口重置指定 Group ID 的消费位点。

使用说明

消息队列 RocketMQ版支持重置 Group 订阅的某一 Topic 或所有 Topic 的消费位点,支持的重置方式包括以下两种。

  • 从最新位点开始消费:该 Group 在消费该 Topic 下的消息时会跳过当前堆积的所有消息,从这之后发送的最新消息开始消费。堆积的消息本身并不会因此被删除。
  • 从指定时间点开始消费:从过去的某个指定时段内选择一个时间点开始消费。该时间段由 Topic 的消息保留时间决定,目前默认为 3 天。

说明

  • 消费模式为广播模式时,不支持重置消费位点。
  • 重置消费位点对重试中的消息不生效,因此重置消费位点后,仍然可能会有部分重试消息投递。
  • RocketMQ Go客户端SDK使用重置消费位点功能时,请使用指定 Commit(83f60c154236bb92a5d5e3d40276b546b6079f1b)及后续版本的社区版 Go SDK,否则可能会引起报错或业务异常。详细说明请参考 Go SDK 概述

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

必选

MQ_INST_********

实例 ID。

Group

String

必选

GID-123123

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

Mode

String

必选

Latest

重置消费位点方式。

  • Latest:从最新位点开始消费。
  • Timestamp:从指定时间点开始消费。

ResetAllTopic

Bool

必选

false

是否重置所有 Topic 的消费位点。

  • true:重置所有 Topic 的消费位点。
  • false:仅重置指定 Topic 的消费位点。

Timestamp

Integer

可选

1648295962

重置消费位点到指定时间点。该参数在 Mode 为 Timestamp 时必填。格式为 Unix 时间戳格式。

Topic

String

可选

newtopic

Topic 名称。ResetAllTopic 为 false 时必选,表示仅重置此 Topic 的消费位点。

响应参数

参数

参数类型

说明

Success

Bool

该操作的执行结果。

  • true:执行成功。
  • false:执行失败。

ErrMsg

String

执行失败时,返回失败原因。

示例

请求示例

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

{
  "InstanceId": "MQ_INST_********",
  "Group": "GID-123",
  "Mode": "Timestamp",
  "ResetAllTopic": false,
  "Timestamp": 1649330788,
  "Topic": "newtopic"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "*********************",
    "Action": "ResetGroupOffset",
    "Version": "2021-04-01",
    "Service": "rocketmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "Success": true,
    "ErrMsg": ""
  }
}