ResetConsumeOffset - 重置消费位点 - 云消息队列 RocketMQ 版

重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时，您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费，您也可以将消费位置移动至最新位点，暂时不处理堆积的消息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:ResetConsumeOffset	update	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	无	无

请求语法

PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	云消息队列 RocketMQ 版的实例 ID。	rmq-cn-tl32ue44x0g
consumerGroupId	string	是	消费者分组 ID。	dolphin_status
topicName	string	是	消费者分组订阅的主题名称。	AMZN_REPORT_TOPIC
body	object	否	请求体对象。
resetType	string	否	重置方式。 CLATEST_OFFSET：从最新位点开始消费。 Group ID 消费指定 Topic 中的消息时，会跳过当前堆积（未被消费）的所有消息，从重置操作时间后发送的最新消息开始消费。 SPECIFIED_TIME：从指定时间的位点开始消费。消费者将从重置时间对应的消费位点之后的消息进行消费，不管这些消息是否已被消费过。可选时间范围中的起始和终止时间分别是该 Topic 中储存的最早的和最晚的一条消息的生产时间，不能选择超过可选时间范围的时间点。重置到某一时刻对应的消费位点，匹配位点时，服务端会根据自动匹配到该时刻最接近的消费位点。	LATEST_OFFSET
resetTime	string	否	指定重置时间。表示消费者将从该时间点对应的消费位点重新开始消费消息。仅当 resetType（重置方式）选择 SPECIFIED_TIME（指定时间）时需要填写该参数。格式为 YYYY-MM-DD HH:mm:ss，例如：2023-11-23 10:00:00。	2023-03-22 12:17:08

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	F9A95891-EAD4-5A2B-8A30-676CD18921AF
success	boolean	是否成功	true
code	string	错误码	MissingInstanceId
message	string	错误信息	The instance cannot be found.
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
  "success": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史