すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetConsumerGroup

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetConsumerGroup

    最終更新日:Jun 01, 2026

    指定のコンシューマーグループの詳細を取得します。

    操作説明

    重要 Alibaba Cloud OpenAPI は、クラウドリソースの管理やクエリのためのコントロールプレーン 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:GetConsumerGroup

    get

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    コンシューマーグループを含むインスタンスの ID です。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    必須

    コンシューマーグループの ID です。

    CID-TEST

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスオブジェクト。

    requestId

    string

    リクエストの一意の ID。この ID を使用して問題をトラブルシューティングします。

    C7F94090-3358-506A-97DC-34BC803C****
    success

    boolean

    呼び出しが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    regionId

    string

    インスタンスが属するリージョンの ID。

    cn-hangzhou
    instanceId

    string

    コンシューマーグループが属するインスタンスの ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    コンシューマーグループの ID。

    CID-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
    deliveryOrderType

    string

    コンシューマーグループのメッセージ配信順序。

    列挙値:

    • Concurrently :

      並列配信

    • Orderly :

      順序付き配信

    Concurrently
    consumeRetryPolicy

    object

    消費再試行ポリシー。 詳細については「消費の再試行」をご参照ください。

    retryPolicy

    string

    再試行ポリシー。

    列挙値:

    • FixedRetryPolicy :

      固定間隔再試行

    • DefaultRetryPolicy :

      バックオフ再試行

    DefaultRetryPolicy
    maxRetryTimes

    integer

    最大再試行回数。

    16
    deadLetterTargetTopic

    string

    デッドレタートピック。

    最大再試行回数を超えてもメッセージの消費に失敗した場合、そのメッセージはデッドレタートピックに送信されます。デッドレタートピックは、ビジネスリカバリやメッセージの追跡に使用できます。詳細については「消費の再試行とデッドレターメッセージ」をご参照ください。

    DLQ_mqtest
    fixedIntervalRetryTime

    integer

    固定再試行間隔 (秒単位)。有効な値の範囲は次のとおりです。

    • 並列配信： 10～1,800

    • 順序付き配信： 1～600

    20
    maxReceiveTps

    integer

    メッセージ消費の最大秒間トランザクション数 (TPS)。

    2000
    messageModel

    string

    消費モード。有効な値は次のとおりです。

    • CLUSTERING： クラスタリング

    • BROADCASTING： ブロードキャスト

    LITE_SELECTIVE
    topicName

    string

    トピック名。

    test1
    exclusive

    boolean

    排他的消費が有効になっているかどうかを示します。

    false
    code

    string

    エラーコード。

    InvalidConsumerGroupId
    message

    string

    エラーメッセージ。

    Parameter consumerGroupId is invalid.
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    ConsumerGroupId
    dynamicMessage

    string

    動的エラーメッセージ。

    consumerGroupId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "status": "RUNNING",
    "remark": "This is the remark for test.",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "deliveryOrderType": "Concurrently",
    "consumeRetryPolicy": {
      "retryPolicy": "DefaultRetryPolicy",
      "maxRetryTimes": 16,
      "deadLetterTargetTopic": "DLQ_mqtest",
      "fixedIntervalRetryTime": 20
    },
    "maxReceiveTps": 2000,
    "messageModel": "LITE_SELECTIVE",
    "topicName": "test1",
    "exclusive": false
  },
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

    エラーコード

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

    変更履歴

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