重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时,您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费,您也可以将消费位置移动至最新位点,暂时不处理堆积的消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
rocketmq:ResetConsumeOffset |
update |
*ConsumerGroup
|
无 | 无 |
请求语法
PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
云消息队列 RocketMQ 版的实例 ID。 |
rmq-cn-tl32ue44x0g |
| consumerGroupId |
string |
是 |
消费者分组 ID。 |
dolphin_status |
| topicName |
string |
是 |
消费者分组订阅的主题名称。 |
AMZN_REPORT_TOPIC |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体对象。 |
|
| resetType |
string |
否 |
重置方式。
枚举值:
|
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"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。