すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetConsumerGroup

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetConsumerGroup

    最終更新日:Sep 24, 2026

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

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスの関連リソースを管理およびクエリするための管理およびコントロール API です。管理およびコントロールデータリンクへの統合のみを推奨します。メッセージの送受信のためのコアデータリンクで OpenAPI を使用することは固く禁じられています。そうしないと、データリンクにリスクが生じる可能性があります。

    今すぐお試しください

    この 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

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

    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

    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

    コンシューマーグループの備考。

    テスト用の備考です
    createTime

    string

    コンシューマーグループが作成された時間。フォーマットは YYYY-MM-DD HH:mm:ss です。

    2022-08-01 20:05:50
    updateTime

    string

    コンシューマーグループが最後に更新された時間。フォーマットは YYYY-MM-DD HH:mm:ss です。

    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 に配信され、後続のビジネス復旧またはレビューに使用されます。詳細については、「消費リトライと死信メッセージ」を参照してください。

    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

    Lite タイプの Topic 名。

    test1
    exclusive

    boolean

    排他的消費が有効かどうかを示します。

    false
    code

    string

    エラーコード。

    InvalidConsumerGroupId
    message

    string

    エラーメッセージ。

    コンシューマーグループ ID が有効ではありません。
    httpStatusCode

    integer

    HTTP 状態コード。

    400
    dynamicCode

    string

    動的エラーコード。

    ConsumerGroupId
    dynamicMessage

    string

    動的エラーメッセージ。

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

    例

    成功レスポンス

    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"
}

    エラーコード

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

    変更履歴

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