全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：ListConsumerGroups - 查詢消費者分組列表

    文件中心

    ApsaraMQ for RocketMQ：ListConsumerGroups - 查詢消費者分組列表

    更新時間：Nov 06, 2025

    查詢指定執行個體下消費者分組的列表資訊。

    介面說明

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:ListConsumerGroups

    list

    *ConsumerGroup

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

    		 無 無

    請求文法

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

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    指定需要擷取哪個執行個體下的消費者分組列表。

    rmq-cn-7e22ody****

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    filter

    string

    否

    查詢的過濾條件，若不輸入則查詢指定執行個體下所有的消費者分組。

    CID-TEST
    pageNumber

    integer

    否

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

    1
    pageSize

    integer

    否

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

    取值範圍：[10,100]。

    10

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Result<MyPage>

    requestId

    string

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

    5503A460-98ED-5543-92CF-4853DE28****
    success

    boolean

    執行結果是否成功。

    true
    data

    object

    返回結果。

    pageNumber

    integer

    當前頁碼。

    1
    pageSize

    integer

    分頁大小。

    10
    totalCount

    integer

    返回結果的總數量。

    1
    list

    array<object>

    分頁資料。

    object

    regionId

    string

    執行個體所屬的地區 ID。

    cn-hangzhou
    instanceId

    string

    執行個體 ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    消費者分組 ID。

    GID-TEST
    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
    maxReceiveTps

    integer

    消費訊息 tps 上限

    1000
    messageModel

    string

    消費模式

    LITE_SELECTIVE
    topicName

    string

    lite 類型的 topicName

    test1
    code

    string

    錯誤碼。

    MissingInstanceId
    message

    string

    錯誤資訊。

    Parameter InstanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP 狀態代碼。

    400
    dynamicCode

    string

    動態錯誤碼。

    InstanceId
    dynamicMessage

    string

    動態錯誤資訊。

    instanceId

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "5503A460-98ED-5543-92CF-4853DE28****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "consumerGroupId": "GID-TEST",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxReceiveTps": 1000,
        "messageModel": "LITE_SELECTIVE",
        "topicName": "test1"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter InstanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    錯誤碼

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

    變更歷史

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