全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：ListInstances - 查詢執行個體列表

    文件中心

    ApsaraMQ for RocketMQ：ListInstances - 查詢執行個體列表

    更新時間：Nov 18, 2025

    查詢指定地區下，所有的雲訊息佇列 RocketMQ 版執行個體的列表資訊。

    介面說明

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:ListInstances

    list

    *Instance

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

    		 無 無

    請求文法

    GET /instances HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    filter

    string

    否

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

    rmq-cn-7e22ody****
    pageNumber

    integer

    否

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

    取值範圍：1~100000000。

    若您設定的參數值小於 1，則系統預設按照參數值為 1 處理；若您設定的參數值大於 100000000，則系統預設按照參數值為 100000000 處理。

    1
    pageSize

    integer

    否

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

    取值範圍：10~200。

    若您設定的參數值小於 10，則系統預設按照參數值為 10 處理；若您設定的參數值大於 200，則系統預設按照參數值為 200 處理。

    10
    resourceGroupId

    string

    否

    執行個體所屬的資源群組 ID。

    rg-acfmx7caj******
    tags

    string

    否

    資源標籤列表，用於篩選執行個體。

    [{"key": "rmq-test", "value": "test"}]
    seriesCodes

    array

    否

    執行個體的主系列編碼。

    參數取值如下：

    • standard：標準版

    • ultimate：鉑金版

    • professional：專業版

    • dedicated： 獨享版

    • shared： 共用版

    string

    否

    執行個體的主系列編碼。

    standard
    storageSecretKey

    string

    否

    儲存加密金鑰 Key

    xxxxx

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Result<MyPage>

    requestId

    string

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

    84445A20-2B50-5306-A3C0-AF99FC1833C6
    success

    boolean

    執行結果是否成功。

    true
    data

    object

    返回結果。

    pageNumber

    integer

    當前頁碼。

    1
    pageSize

    integer

    分頁大小。

    10
    totalCount

    integer

    返回結果的總數量。

    100
    list

    array<object>

    分頁資料。

    array<object>

    regionId

    string

    執行個體所屬的地區 ID。

    cn-hangzhou
    instanceId

    string

    執行個體 ID。

    rmq-cn-7e22ody****
    instanceName

    string

    執行個體名稱。

    test instance
    status

    string

    執行個體狀態。

    參數取值如下：

    • RELEASED（已釋放）

    • RUNNING（運行中）

    • STOPPED（已停服）

    • CHANGING（變更中）

    • CREATING（建立中）

    枚舉值：

    • RELEASED :

      已釋放

    • RUNNING :

      運行中

    • STOPPED :

      已停服

    • CHANGING :

      變更中

    • CREATING :

      建立中

    RUNNING
    startTime

    string

    執行個體的建立時間。

    2022-08-01 00:00:00
    expireTime

    string

    執行個體的到期時間。

    2022-09-01 00:00:00
    releaseTime

    string

    執行個體的釋放時間。

    2022-09-07 00:00:00
    userId

    string

    執行個體所屬的使用者識別碼。

    6W0xz2uPfiwp****
    commodityCode

    string

    訊息佇列 RocketMQ 5.x 系列執行個體的商品代號，類似於 ons_rmqsub_public_cn。

    ons_rmqsub_public_cn
    serviceCode

    string

    執行個體所屬的服務編碼。訊息佇列 RocketMQ 版的服務編碼為 rmq。

    rmq
    seriesCode

    string

    執行個體的主系列編碼。

    參數取值如下：

    • standard：標準版

    • ultimate：鉑金版

    • professional：專業版

    • shared: 共用版

    • dedicated：獨享版

    枚舉值：

    • standard :

      標準版

    • ultimate :

      鉑金版

    • professional :

      專業版

    standard
    subSeriesCode

    string

    執行個體的子系列編碼。

    參數取值如下：

    • cluster_ha：叢集高可用版

    • single_node：單節點版

    • serverless： serverless 版本

    枚舉值：

    • cluster_ha :

      叢集高可用版

    • single_node :

      單節點版

    cluster_ha
    paymentType

    string

    執行個體的付費類型。

    參數取值如下：

    • PayAsYouGo：隨用隨付（後付費）

    • Subscription：訂用帳戶（預付費）

    枚舉值：

    • PayAsYouGo :

      隨用隨付（後付費）

    • Subscription :

      訂用帳戶（預付費）

    Subscription
    remark

    string

    執行個體的備忘資訊。

    This is remark for instance.
    topicCount

    integer

    執行個體中所建立的主題數量。

    20
    groupCount

    integer

    執行個體中所建立的消費者分組的數量。

    10
    createTime

    string

    執行個體的版本更新時間。

    2022-08-01 00:00:00
    updateTime

    string

    執行個體的最後修改時間。

    2022-08-02 00:00:00
    resourceGroupId

    string

    執行個體所屬的資源群組 ID。

    rg-acfmx7caj******
    tags

    array<object>

    資源標籤列表。

    object

    資源標籤。

    key

    string

    資源標籤 key 值。

    key
    value

    string

    資源標籤 value 值。

    value
    productInfo

    object

    產品資訊。

    traceOn

    boolean

    是否開啟訊息軌跡功能。

    • true：開啟訊息軌跡功能

    • false：關閉訊息軌跡功能

    該參數暫不生效，不管參數是否開啟，執行個體都預設支援軌跡功能。

    true
    capacityType

    string

    容量模式:

    • provisioned： 預留+彈性

    • ondemand： 隨用隨付

    provisioned
    code

    string

    錯誤碼。

    MissingPageNumber
    message

    string

    錯誤資訊。

    Parameter pageNumber is mandatory for this action .
    httpStatusCode

    integer

    HTTP 狀態代碼。

    400
    dynamicCode

    string

    動態錯誤碼。

    PageNumber
    dynamicMessage

    string

    動態錯誤資訊。

    pageNumber

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 100,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "instanceName": "test instance",
        "status": "RUNNING",
        "startTime": "2022-08-01 00:00:00",
        "expireTime": "2022-09-01 00:00:00",
        "releaseTime": "2022-09-07 00:00:00",
        "userId": "6W0xz2uPfiwp****",
        "commodityCode": "ons_rmqsub_public_cn",
        "serviceCode": "rmq",
        "seriesCode": "standard",
        "subSeriesCode": "cluster_ha",
        "paymentType": "Subscription",
        "remark": "This is remark for instance.",
        "topicCount": 20,
        "groupCount": 10,
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-02 00:00:00",
        "resourceGroupId": "rg-acfmx7caj******",
        "tags": [
          {
            "key": "key",
            "value": "value"
          }
        ],
        "productInfo": {
          "traceOn": true,
          "capacityType": "provisioned"
        }
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "Parameter pageNumber is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "PageNumber",
  "dynamicMessage": "pageNumber"
}

    錯誤碼

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

    變更歷史

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