すべてのプロダクト
Search

このプロダクト

    :GetConsumerGroup

    ドキュメントセンター

    :GetConsumerGroup

    最終更新日:Nov 06, 2025

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

    操作説明

    重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースを管理およびクエリするために使用されるコントロールプレーン 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

    Result<ConsumerGroupDTO>

    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

    デッドレター Topic。

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

    DLQ_mqtest
    fixedIntervalRetryTime

    integer

    固定リトライ間隔。単位: 秒。有効値は次のとおりです:

    • Concurrently: 10～1800

    • Orderly: 1～600

    20
    maxReceiveTps

    integer

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

    2000
    messageModel

    string

    消費モード:

    • CLUSTERING: クラスタリング消費

    • LITE_SELECTIVE: LITE_SELECTIVE

    LITE_SELECTIVE
    topicName

    string

    ライト Topic の名前。

    test1
    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"
  },
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

    エラーコード

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

    変更履歴

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