文档

OnsConsumerResetOffset - 重置Group ID消费位点

更新时间:
一键部署

重置指定的Group ID的消费位点到指定时间戳。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
本接口一般用于清理堆积消息,或者回溯消费。有以下两种清理方式:

  • 清理所有消息

  • 清理消费进度到指定的时间

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:ResetConsumerOffsetRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

需查询的消费端 Group ID。

GID_test_consumer_id
Topicstring

需重置位点的 Topic。

test-mq-topic
Typeinteger

消息清理类型。取值说明如下:

  • 0:清除所有消息。该 Group ID 在消费该 Topic 下的消息时会跳过当前堆积(未被消费)的所有消息,从这之后发送的最新消息开始消费。

对于程序返回"reconsumeLater",即走重试流程的这部分消息来说,清除无效。

  • 1:清理到指定时间。请指定一个时间点,这个时间点之后发送的消息才会被消费。

可选时间范围中的起始和终止时间分别是该 Topic 中储存的最早的和最晚的一条消息的生产时间。不能选择超过可选时间范围的时间点。

1
ResetTimestamplong

重置位点到指定的时间戳,仅在 Type1 时生效。单位:毫秒。

1591153871000
InstanceIdstring

需查询的 Group ID 所对应的实例 ID。

MQ_INST_111111111111_DOxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

D52C68F8-EC5D-4294-BFFF-1A6A25AF****

示例

正常返回示例

JSON格式

{
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

除了调用 OnsConsumerResetOffset 接口,您还可以通过云消息队列 RocketMQ 版控制台重置指定 Group ID 的消费位点。具体操作,请参见重置消费位点

  • 本页导读 (1)