全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：OnsConsumerResetOffset - 重設Group ID消費位點

    文件中心

    ApsaraMQ for RocketMQ：OnsConsumerResetOffset - 重設Group ID消費位點

    更新時間：Dec 21, 2025

    重設指定的Group ID的消費位點到指定時間戳記。

    介面說明

    重要 阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
    本介面一般用於清理堆積訊息，或者回溯消費。有以下兩種清理方式：

    • 清理所有訊息

    • 清理消費進度到指定的時間

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:ResetConsumerOffset

    get

    Topic

    acs:mq:{#regionId}:{#accountId}:{#TopicName}

    Topic

    acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

    		 無
    • mq:OnsInstanceBaseInfo

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GroupId

    string

    是

    需查詢的消費端 Group ID。

    GID_test_consumer_id
    Topic

    string

    是

    需重設位點的 Topic。

    test-mq-topic
    Type

    integer

    是

    訊息清理類型。取值說明如下：

    • 0：清除所有訊息。該 Group ID 在消費該 Topic 下的訊息時會跳過當前堆積（未被消費）的所有訊息，從這之後發送的最新訊息開始消費。

    對於程式返回"reconsumeLater"，即走重試流程的這部分訊息來說，清除無效。

    • 1：清理到指定時間。請指定一個時間點，這個時間點之後發送的訊息才會被消費。

    可選時間範圍中的起始和終止時間分別是該 Topic 中儲存的最早的和最晚的一條訊息的生產時間。不能選擇超過可選時間範圍的時間點。

    1
    ResetTimestamp

    integer

    否

    重設位點到指定的時間戳記，僅在 Type 為 1 時生效。單位：毫秒。

    1591153871000
    InstanceId

    string

    否

    需查詢的 Group ID 所對應的執行個體 ID。

    MQ_INST_111111111111_DOxxxxxx

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。

    D52C68F8-EC5D-4294-BFFF-1A6A25AF****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。