全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：OnsTopicList - 擷取Topic列表資訊

    文件中心

    ApsaraMQ for RocketMQ：OnsTopicList - 擷取Topic列表資訊

    更新時間：Jan 06, 2026

    查詢帳號下所有Topic的資訊列表。

    介面說明

    重要 阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
    本介面一般用於產生資源清單的情境，並不查看具體資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:ListTopic

    list

    Instance

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

    		 無
    • mq:QueryInstanceBaseInfo

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Topic

    string

    否

    查詢指定 Topic 時設定，若不輸入，則查詢所有 Topic。

    test
    InstanceId

    string

    否

    需擷取的 Topic 資訊列表所對應的執行個體 ID。

    MQ_INST_188077086902****_BXSuW61e
    Tag

    array<object>

    否

    Topic 所綁定的標籤列表。列表元素個數不得超過 20。

    object

    否

    返回的標籤結構。

    Key

    string

    是

    Topic 的標籤鍵。Key 和 Value 值必須同時輸入或同時不輸入。若同時輸入表示根據 Tag 過濾合格 Topic，若不輸入表示查詢所有 Topic。

    • 如果輸入該值，則取值不允許為空白字串。

    • 最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

    CartService
    Value

    string

    是

    Topic 的標籤值。Key 和 Value 值必須同時輸入或同時不輸入。若同時輸入表示根據 Tag 過濾合格 Topic，若不輸入表示查詢所有 Topic。

    • 如果輸入該值，取值允許為空白字串。

    • 最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

    ServiceA

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回的資料結構。

    RequestId

    string

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

    4A978869-7681-4529-B470-107E1379****
    Data

    object

    PublishInfoDo

    array<object>

    返回指定執行個體的 Topic 資訊列表。

    array<object>

    返回的 Topic 的資料結構。

    MessageType

    integer

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

    • 0：普通訊息

    • 1：分區順序訊息

    • 2：全域順序訊息

    • 4：事務訊息

    • 5：定時/延時訊息

    0
    RelationName

    string

    所有關係名稱，例如持有人、可訂閱、可發布和可發布訂閱。

    授權發布/訂閱
    Owner

    string

    Topic 所有者編號，為阿里雲的帳號 ID。

    138015630679****
    IndependentNaming

    boolean

    Topic 所在執行個體是否有命名空間。取值說明如下：

    • true：擁有獨立命名空間，資源命名確保執行個體內唯一，跨執行個體之間可重名。

    • false：無獨立命名空間，執行個體內或者跨執行個體之間，資源命名必須全域唯一。

    true
    Remark

    string

    備忘資訊。

    測試
    Relation

    integer

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

    • 1：持有人

    • 2：發行就緒

    • 4：可以訂閱

    • 6：發行就緒和訂閱

    6
    CreateTime

    integer

    建立時間。

    1570700947000
    Topic

    string

    Topic 名稱。

    test
    Tags

    object

    Tag

    array<object>

    Topic 所綁定的標籤。

    object

    標籤結構定義。

    Key

    string

    標籤鍵。

    CartService
    Value

    string

    標籤值。

    SrviceA
    InstanceId

    string

    Topic 所在的執行個體 ID。

    MQ_INST_188077086902****_BXSuW61e
    ServiceStatus

    integer

    Topic 非同步建立的狀態。取值說明如下：

    • 0：建立中。

    • 1：服務中。

    0

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "4A978869-7681-4529-B470-107E1379****",
  "Data": {
    "PublishInfoDo": [
      {
        "MessageType": 0,
        "RelationName": "授權發布/訂閱",
        "Owner": "138015630679****",
        "IndependentNaming": true,
        "Remark": "測試",
        "Relation": 6,
        "CreateTime": 1570700947000,
        "Topic": "test",
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "SrviceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "ServiceStatus": 0
      }
    ]
  }
}

    錯誤碼

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

    變更歷史

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