すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:ListConsumerConnections

    ドキュメントセンター

    ApsaraMQ for RocketMQ:ListConsumerConnections

    最終更新日:Nov 06, 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:ListConsumerConnections

    list

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-uax32mf9h1f
    consumerGroupId

    string

    必須

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

    GID_TEST_STOCK_OPEND_GW

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    topicName

    string

    任意

    ライト Topic の名前。

    test1
    liteTopicName

    string

    任意

    Lite メッセージキュー (MSMQ) Topic の名前。

    abc

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果

    requestId

    string

    リクエスト ID。

    A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4
    success

    boolean

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

    true
    data

    object

    返されたデータ。

    regionId

    string

    リージョン ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

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

    CID-TEST
    connections

    array<object>

    クライアント接続のリスト。

    object

    クライアント接続のリスト。

    clientId

    string

    クライアント ID。

    172.17.135.197@17392#1936705963#551717232#9873695589062458
    hostname

    string

    クライアントのホスト名。

    vos
    egressIp

    string

    ホストの IP アドレスまたはインターネットの出口 IP アドレス。

    xx.xx.xx.xx
    language

    string

    クライアントの言語。

    java
    version

    string

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

    1.0
    messageModel

    string

    コンシューマーの消費モード:

    • CLUSTERING

    • LITE_SELECTIVE

    • BROADCASTING

    BROADCASTING
    code

    string

    エラーコード。

    MissingPageNumber
    message

    string

    エラーメッセージ。

    The instance cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "connections": [
      {
        "clientId": "172.17.135.197@17392#1936705963#551717232#9873695589062458",
        "hostname": "vos",
        "egressIp": "xx.xx.xx.xx",
        "language": "java",
        "version": "1.0",
        "messageModel": "BROADCASTING"
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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