全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：ListTopics - 查詢主題列表

    文件中心

    ApsaraMQ for RocketMQ：ListTopics - 查詢主題列表

    更新時間：Nov 06, 2025

    查詢指定執行個體下的主題列表資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:ListTopics

    list

    *Topic

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*

    		 無 無

    請求文法

    GET /instances/{instanceId}/topics HTTP/1.1

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    指定需要擷取哪個執行個體下的主題列表。

    rmq-cn-7e22ody****

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    filter

    string

    否

    查詢的過濾條件，若不輸入則查詢該執行個體下所有的主題。

    topic_test
    pageNumber

    integer

    否

    分頁頁碼，查詢第幾頁的返回結果。

    1
    pageSize

    integer

    否

    分頁大小，每頁最多顯示的返回結果數量。

    3
    messageTypes

    array

    否

    主題的訊息類型。

    string

    否

    需要查詢執行個體下哪種類型的主題。若不輸入，則查詢執行個體下的所有主題。 參數取值如下：

    • TRANSACTION：事務訊息

    • FIFO：順序訊息

    • DELAY：定時/延時訊息

    • NORMAL：普通訊息

    • LITE: 輕量類型

    枚舉值：

    • TRANSACTION :

      事務訊息

    • FIFO :

      順序訊息

    • DELAY :

      定時/延時訊息

    • LITE :

      輕量類型

    • NORMAL :

      普通訊息

    NORMAL

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Result<MyPage>

    requestId

    string

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

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

    執行結果是否成功。

    true
    data

    object

    返回結果。

    pageNumber

    integer

    當前頁碼。

    1
    pageSize

    integer

    分頁大小。

    3
    totalCount

    integer

    返回結果的總數量。

    1
    list

    array<object>

    分頁資料。

    object

    regionId

    string

    執行個體所屬的地區 ID。

    cn-hangzhou
    instanceId

    string

    執行個體 ID。

    rmq-cn-7e22ody****
    topicName

    string

    主題名稱。

    topic_test
    messageType

    string

    主題的訊息類型。

    枚舉值：

    • TRANSACTION :

      事務訊息

    • FIFO :

      順序訊息

    • DELAY :

      定時/延時訊息

    • NORMAL :

      普通訊息

    NORMAL
    status

    string

    主題的狀態。

    枚舉值：

    • RUNNING :

      運行中

    • CREATING :

      建立中

    RUNNING
    remark

    string

    主題的備忘資訊。

    This is the remark for test.
    createTime

    string

    建立時間

    2022-08-01 20:05:50
    updateTime

    string

    主題的最後修改時間。

    2022-08-01 20:05:50
    maxSendTps

    integer

    發送訊息 tps 上限

    1000
    liteTopicExpiration

    integer

    lite 類型 Topic 到期時間，單位：分鐘

    20
    code

    string

    錯誤碼。

    Topic.NotFound
    message

    string

    錯誤資訊。

    The topic cannot be found.
    httpStatusCode

    integer

    HTTP 狀態代碼。

    400
    dynamicCode

    string

    動態錯誤碼。

    TopicName
    dynamicMessage

    string

    動態錯誤資訊。

    topicName

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageType": "NORMAL",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxSendTps": 1000,
        "liteTopicExpiration": 20
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

    錯誤碼

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

    變更歷史

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