すべてのプロダクト
Search

このプロダクト

    :CreateConsumerGroup

    ドキュメントセンター

    :CreateConsumerGroup

    最終更新日:Nov 06, 2025

    ApsaraMQ for RocketMQ の使用者グループを作成します。 使用者グループは、同じ消費動作を持つ複数のコンシューマーを含む負荷分散グループです。 コンシューマーは、メッセージをサブスクライブするために、使用者グループと関連する Topic を指定する必要があります。

    操作説明

    重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースを管理およびクエリするために使用される管理 API です。 この API は管理目的でのみ統合してください。 メッセージを送受信するコアデータリンクにこの API を使用しないでください。 データリンクにリスクをもたらす可能性があります。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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。 この ID は使用者グループを識別するために使用され、グローバルに一意である必要があります。

    値は次の要件を満たす必要があります:

    • ID には、文字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。

    • ID の長さは 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

    任意

    使用者グループがサブスクライブするライト Topic の名前。 このパラメーターは、messageModel を LITE_SELECTIVE に設定した場合に必要です。

    liteTopicTest

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<boolean>

    requestId

    string

    リクエスト ID。 各リクエストには一意の 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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。