全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：OnsGroupList - 擷取Group ID列表資訊

    文件中心

    ApsaraMQ for RocketMQ：OnsGroupList - 擷取Group ID列表資訊

    更新時間：Dec 12, 2025

    查詢指定執行個體下所有的Group ID資訊。

    介面說明

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:ListGroup

    list

    Group

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

    		 無
    • mq:QueryInstanceBaseInfo

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    否

    需擷取資源清單的 Group ID 所對應的執行個體 ID。

    MQ_INST_111111111111_DOxxxxxx
    GroupId

    string

    否

    模糊查詢指定 Group ID 時設定，否則查詢所有 Group ID。

    如果輸入 GID_ABC 查詢，那麼會以前尾碼匹配的方式進行模糊查詢，返回所有包含*GID_ABC*的 Group ID，例如 GID_test_GID_ABC_123、GID_ABC_356。

    GID_test_group_id
    GroupType

    string

    否

    查詢的 Group ID 適用的協議。TCP 協議和 HTTP 協議的 Group ID 不可以共用，需要分別建立。取值說明如下：

    • tcp：預設值，表示該 Group ID 僅適用於 TCP 協議的訊息收發。

    • http：表示該 Group ID 僅適用於 HTTP 協議的訊息收發。

    tcp
    Tag

    array<object>

    否

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

    object

    否

    Key

    string

    是

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

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

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

    CartService
    Value

    string

    是

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

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

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

    ServiceA

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

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

    16996623-AC4A-43AF-9248-FD9D2D75****
    Data

    object

    SubscribeInfoDo

    array<object>

    查詢到的訂閱關係集合。

    array<object>

    Owner

    string

    該發布資訊的擁有者。

    138015630679****
    UpdateTime

    integer

    該 Group ID 的更新時間。

    1570700979000
    IndependentNaming

    boolean

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

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

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

    true
    GroupId

    string

    Group ID 即消費叢集組 ID。

    GID_test_group_id
    Remark

    string

    備忘。

    test
    CreateTime

    integer

    Group ID 的建立時間。

    1568896605000
    Tags

    object

    Tag

    array<object>

    Group ID 所綁定的標籤。

    object

    Key

    string

    標籤鍵。

    CartService
    Value

    string

    標籤值。

    ServiceA
    InstanceId

    string

    執行個體 ID。

    MQ_INST_111111111111_DOxxxxxx
    GroupType

    string

    查詢的 Group ID 適用的協議。TCP 協議和 HTTP 協議的 Group ID 不可以共用，需要分別建立。取值說明如下：

    • tcp：表示該 Group ID 僅適用於 TCP 協議的訊息收發。

    • http：表示該 Group ID 僅適用於 HTTP 協議的訊息收發。

    tcp

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data": {
    "SubscribeInfoDo": [
      {
        "Owner": "138015630679****",
        "UpdateTime": 1570700979000,
        "IndependentNaming": true,
        "GroupId": "GID_test_group_id",
        "Remark": "test",
        "CreateTime": 1568896605000,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "GroupType": "tcp"
      }
    ]
  }
}

    錯誤碼

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

    變更歷史

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