重置指定的 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 | 消息清理類型,取值說明如下:
|
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。