调用OnsConsumerResetOffset重置指定的Group ID的消费位点到指定时间戳。
使用说明
本接口一般用于清理堆积消息,或者回溯消费。有以下两种清理方式:
- 清理所有消息
- 清理消费进度到指定的时间
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例。
API |
Action |
Resource(有命名空间) |
Resource(无命名空间) |
---|---|---|---|
OnsConsumerResetOffset |
mq:QueryInstanceBaseInfo mq:ResetConsumerOffset |
acs:mq:*:*:{instanceId}%{topic} |
acs:mq:*:*:{topic} |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsConsumerResetOffset |
系统规定参数。取值:OnsConsumerResetOffset。 |
GroupId | String | 是 | GID_test_consumer_id |
需查询的消费端Group ID。 |
Topic | String | 是 | test-mq-topic |
需重置位点的Topic。 |
Type | Integer | 是 | 1 |
消息清理类型。取值说明如下:
|
ResetTimestamp | Long | 否 | 1591153871000 |
重置位点到指定的时间戳,仅在Type为1时生效。单位:毫秒。 |
InstanceId | String | 是 | MQ_INST_111111111111_DOxxxxxx |
需查询的Group ID所对应的实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D52C68F8-EC5D-4294-BFFF-1A6A25AF**** |
公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
示例
请求示例
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerResetOffset
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test-mq-topic
&Type=1
&ResetTimestamp=1591153871000
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<OnsConsumerResetOffsetResponse>
<RequestId>D52C68F8-EC5D-4294-BFFF-1A6A25AF****</RequestId>
</OnsConsumerResetOffsetResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}
错误码
访问错误中心查看更多错误码。
控制台操作
除了调用OnsConsumerResetOffset接口,您还可以通过消息队列RocketMQ版控制台重置指定Group ID的消费位点。具体操作,请参见重置消费位点。