更新时间:2026-04-03 GMT+08:00

重置消费进度

功能介绍

重置消费进度。

URI

POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}/reset-message-offset

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

参数解释:

引擎。

约束限制:

不涉及。

取值范围:

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值:

不涉及。

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

group

是

String

参数解释:

消费组名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topic

是

String

参数解释:

重置的主题。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

timestamp

是

String

参数解释:

重置的时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

queues

Array of queues objects

参数解释:

重置的队列。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 queues

参数

参数类型

描述

broker_name

String

参数解释:

队列所在的broker。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

queue_id

Integer

参数解释:

队列ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

timestamp_offset

Long

参数解释:

重置消费进度。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

重置topic_01主题的消费进度到指定时间点。

POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset

{
  "topic" : "topic_01",
  "timestamp" : 1662652800000
}

响应示例

状态码:200

重置消费进度成功。

{
  "queues" : [ {
    "broker_name" : "broker-1",
    "queue_id" : 0,
    "timestamp_offset" : 0
  } ]
}

状态码

状态码

描述

200

重置消费进度成功。

错误码

请参见错误码。