すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetConsumerGroupSubscription

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetConsumerGroupSubscription

    最終更新日:Dec 21, 2025

    コンシューマーグループのサブスクリプションをクエリします。

    今すぐお試しください

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

    get

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-uqm32kqyy11
    consumerGroupId

    string

    必須

    サブスクリプションをクエリするコンシューマーグループの ID。

    common_dev
    topicName

    string

    必須

    コンシューマーグループがサブスクライブするトピックの名前。

    mq003

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    requestId

    string

    リクエスト ID。

    157DF7D4-53FB-58C6-BEBC-A9400E7EF68A
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    array<object>

    返されたデータ。

    array<object>

    サブスクリプション。

    subscriptionDTO

    object

    サブスクリプションの詳細。

    consumerGroupId

    string

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

    GID_inspector_group
    topicName

    string

    コンシューマーグループがサブスクライブするトピック。

    Topic_normal_inspector
    messageModel

    string

    コンシューマーグループの消費モード。有効な値：

    • BROADCASTING：ブロードキャスト消費

    • CLUSTERING：クラスター消費

    BROADCASTING
    subscriptionStatus

    string

    サブスクリプションステータス。有効な値：

    • ONLINE：コンシューマーグループはオンラインです。コンシューマーグループに複数のコンシューマーが含まれている場合、少なくとも 1 つのコンシューマーがオンラインであれば、この値が返されます。

    • OFFLINE：コンシューマーグループはオフラインです。コンシューマーグループに複数のコンシューマーが含まれている場合、すべてのコンシューマーがオフラインの場合にのみ、この値が返されます。

    ONLINE
    filterExpression

    string

    フィルター式。

    *
    filterExpressionType

    string

    フィルター式のタイプ。有効な値：

    • SQL：SQL 式を使用してメッセージをフィルターします。

    • TAG：タグを使用してメッセージをフィルターします。

    UNSPECIFIED
    connectionDTO

    object

    接続の詳細。

    clientId

    string

    クライアント ID。

    192.168.50.191@19908#-2093249153#1534215565#40385215750900
    hostname

    string

    ホスト名。

    nginx
    egressIp

    string

    ホストのパブリック IP アドレス。

    xx.xx.xx.xx
    language

    string

    クライアントが使用する言語。

    zh
    version

    string

    クライアントのバージョン。

    1.0.0
    messageModel

    string

    コンシューマーグループの消費モード。有効な値：

    • BROADCASTING：ブロードキャスト消費

    • CLUSTERING：クラスター消費

    BROADCASTING
    code

    string

    エラーコード。

    Instance.NotFound
    message

    string

    エラーメッセージ。

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    レスポンスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "157DF7D4-53FB-58C6-BEBC-A9400E7EF68A",
  "success": true,
  "data": [
    {
      "subscriptionDTO": {
        "consumerGroupId": "GID_inspector_group",
        "topicName": "Topic_normal_inspector",
        "messageModel": "BROADCASTING",
        "subscriptionStatus": "ONLINE",
        "filterExpression": "*",
        "filterExpressionType": "UNSPECIFIED"
      },
      "connectionDTO": {
        "clientId": "192.168.50.191@19908#-2093249153#1534215565#40385215750900",
        "hostname": "nginx",
        "egressIp": "xx.xx.xx.xx",
        "language": "zh",
        "version": "1.0.0",
        "messageModel": "BROADCASTING"
      }
    }
  ],
  "code": "Instance.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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