すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:CreateConsumerGroup

    ドキュメントセンター

    ApsaraMQ for RocketMQ:CreateConsumerGroup

    最終更新日:Sep 24, 2026

    ApsaraMQ for RocketMQ 用のコンシューマーグループ (ConsumerGroup) を作成します。コンシューマーグループは、ApsaraMQ for RocketMQ における負荷分散グループであり、一貫した消費動作を持つ複数のコンシューマーを含みます。コンシューマーは、メッセージのサブスクリプションを実装するために、コンシューマーグループを指定して関連する Topic をサブスクライブする必要があります。

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI 操作は、Alibaba Cloud サービスのリソースを管理および照会するために使用される管理 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

    *コンシューマーグループ。

    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 として使用され、グローバルに一意です。

    有効な値:

    • 文字の制限: 文字 a~z または A~Z、数字 0~9、アンダースコア (_)、およびハイフン (-)。

    • 長さの制限: 1 ~ 60 文字。

    予約語の制限については、「パラメーターの制限」を参照してください。

    GID_test_グループId

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    リクエストボディオブジェクト。

    remark

    string

    任意

    作成するコンシューマーグループの備考。

    これはテスト用の備考です
    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: 軽量消費パターン。コンシューマーグループ内のコンシューマーは異なるサブスクリプションを持てます。

    列挙値:

    • CLUSTERING :

      クラスター消費パターン。

    • LITE_SELECTIVE :

      軽量消費パターン。

    LITE_SELECTIVE
    topicName

    string

    任意

    LITE_SELECTIVE 消費パターンを使用する際にサブスクライブする Lite タイプの Topic の名前。

    liteTopicTest
    exclusive

    boolean

    任意

    排他的サブスクリプションを有効にするかどうかを指定します。排他的サブスクリプションでは、1 つの LiteTopic をサブスクライブするのは 1 つのコンシューマーのみです。有効にする場合は true に、無効にする場合は false に設定します。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<ブール値>。

    requestId

    string

    リクエスト ID。各リクエストに一意の ID が割り当てられ、トラブルシューティングおよび問題の特定に使用できます。

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

    boolean

    実行する操作が成功したかどうかを示します。

    true
    data

    boolean

    返される結果。

    true
    code

    string

    エラーコード。

    InvalidConsumerGroupId (有効)
    message

    string

    エラーメッセージ。

    パラメーター consumerGroupId (コンシューマーグループ ID) は無効です。有効な値を指定してください。
    httpStatusCode

    integer

    HTTP 状態コード。

    400
    dynamicCode

    string

    動的エラーコード。

    ConsumerGroupId
    dynamicMessage

    string

    動的エラーメッセージ。

    consumerGroupId (コンシューマーグループ ID)

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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