全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：CreateConsumerGroup - 建立消費者分組

    文件中心

    ApsaraMQ for RocketMQ：CreateConsumerGroup - 建立消費者分組

    更新時間：Nov 06, 2025

    建立雲訊息佇列 RocketMQ 版的消費者分組（ConsumerGroup）。消費者分組是雲訊息佇列 RocketMQ 版系統中承載多個消費行為一致的消費者的負載平衡分組。消費者需要通過指定消費者分組訂閱相關的主題來實現訊息訂閱。

    介面說明

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:CreateConsumerGroup

    create

    *ConsumerGroup

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

    		 無 無

    請求文法

    POST /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    待建立的消費者分組所屬的執行個體 ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    是

    待建立的消費者分組的 ID。用於標識消費者分組，全域唯一。

    取值說明如下：

    • 字元限制：支援字母 a~z 或 A~Z、數字 0~9 以及底線（_）、短劃線（-）。

    • 長度限制：1~60 個字元。

    保留字元限制，請參見參數限制。

    GID_test_groupId

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    body

    object

    否

    請求體對象。

    remark

    string

    否

    待建立消費者分組的備忘資訊。

    This is the remark for test.
    deliveryOrderType

    string

    是

    待建立消費者分組的投遞順序性。

    參數取值如下：

    • Concurrently：並發投遞

    • Orderly：順序投遞

    枚舉值：

    • Concurrently :

      並發投遞

    • Orderly :

      順序投遞

    Concurrently
    consumeRetryPolicy

    object

    是

    待建立消費者分組的消費重試策略。更多資訊，請參見 消費重試。

    maxRetryTimes

    integer

    否

    最大重試次數。

    16
    retryPolicy

    string

    是

    重試策略類型。更多資訊，請參見訊息重試。

    參數取值如下：

    • FixedRetryPolicy：固定間隔重試，僅支援順序投遞

    • DefaultRetryPolicy：階梯退避重試，僅支援並發投遞

    枚舉值：

    • FixedRetryPolicy :

      固定間隔重試

    • DefaultRetryPolicy :

      階梯退避重試

    DefaultRetryPolicy
    deadLetterTargetTopic

    string

    否

    死信 Topic。

    消費者出現異常消費某條訊息失敗，且訊息重試後依然未成功，訊息將被投遞至死信 Topic 中，以便後續進行業務恢複或回溯。更多資訊，請參見消費重試與死信。

    DLQ_mqtest
    fixedIntervalRetryTime

    integer

    否

    固定稍候再試，單位：秒。重試策略為 FixedRetryPolicy 固定間隔重試策略時生效 取值範圍：

    • 並發投遞：10-1800

    • 順序投遞：1-600

    10
    maxReceiveTps

    integer

    否

    消費訊息 tps 上限

    1000
    messageModel

    string

    否

    消費者對訊息的消費模式：

    • CLUSTERING

    • LITE_SELECTIVE

    LITE_SELECTIVE
    topicName

    string

    否

    LITE_SELECTIVE 消費模式時，需要訂閱的 lite 類型的 topic 名稱

    liteTopicTest

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Result

    requestId

    string

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

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

    boolean

    執行結果是否成功。

    true
    data

    boolean

    返回結果。

    true
    code

    string

    錯誤碼。

    InvalidConsumerGroupId
    message

    string

    錯誤資訊。

    Parameter consumerGroupId is invalid.
    httpStatusCode

    integer

    HTTP 狀態代碼。

    400
    dynamicCode

    string

    動態錯誤碼。

    ConsumerGroupId
    dynamicMessage

    string

    動態錯誤資訊。

    consumerGroupId

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

    錯誤碼

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

    變更歷史

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