重置指定的 Group ID 的消费位点到指定时间戳。本接口一般用于清理堆积消息,或者回溯消费。提供以下两种清理方式:清理所有消息、清理消费进度到指定的时间。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ResetMqSofamqConsumerOffset

系统规定参数。取值:ResetMqSofamqConsumerOffset

Cell String RZ01A

需要查询的单元。

GroupId String GID_test_consumer_id

需查询的消费端 Group ID。

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

ResetTimestamp Long 1568033253000

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

Topic String test-mq-topic

需重置位点的 Topic 名称。

Type Long 1

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

  • 0:清除所有消息。
  • 1:清理到指定时间。

返回数据

名称 类型 示例值 描述
ResultMessage String OK

结果描述

ResultCode String OK

结果码

RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求 ID

示例

请求示例

http(s)://[Endpoint]/?Action=ResetMqSofamqConsumerOffset
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test-mq-topic	
&Type=1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "861E6630-AEC0-4B2D-B214-6CB5E44B7F04",
  "ResultMessage" : "OK",
  "ResultCode" : "OK"
}

错误码

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