全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：OnsTopicStatus - 查詢Topic狀態

    文件中心

    ApsaraMQ for RocketMQ：OnsTopicStatus - 查詢Topic狀態

    更新時間：Apr 21, 2026

    查詢當前Topic下的訊息總量以及Topic的狀態。

    介面說明

    重要 阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
    本介面一般用於判斷 Topic 資源的使用率。調用本介面後返回的資訊包含當前伺服器上該 Topic 所有的訊息數，以及最後訊息寫入時間。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:QueryTopicStatus

    get

    Topic

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

    Topic

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

    		 無
    • mq:OnsInstanceBaseInfo

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Topic

    string

    是

    需查詢的 Topic 名稱。

    test
    InstanceId

    string

    否

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

    MQ_INST_188077086902****_BXSuW61e

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資訊。

    RequestId

    string

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

    427EE49D-D762-41FB-8F3D-9BAC96C3****
    Data

    object

    查詢到的 Topic 的資訊儲存資料結構。

    Perm

    integer

    所有關係編號。取值說明如下：

    • 2：發行就緒

    • 4：可以訂閱

    • 6：發行就緒和訂閱

    6
    LastTimeStamp

    integer

    當前 Topic 內最新一條訊息的就緒時間，如果 Topic 內沒有訊息，則該參數傳回值為 0。

    該參數值的格式為毫秒級 Unix 時間戳記。

    就緒訊息及就緒時間具體含義，請參見名詞解釋。

    1570864984364
    TotalCount

    integer

    當前 Topic 的所有分區存在的訊息數總和。

    2310

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****",
  "Data": {
    "Perm": 6,
    "LastTimeStamp": 1570864984364,
    "TotalCount": 2310
  }
}

    錯誤碼

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

    變更歷史

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