判斷指定 Group ID 的消費者是否在線,并獲取詳細的客戶端連接的列表。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String QueryMqSofamqConsumerConnection

系統規定參數。取值:QueryMqSofamqConsumerConnection。

Cell String RZ01A

需要查詢的 Group ID 所在的單元

GroupId String GID_test_consumer_id

需查詢的 Group ID

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查詢的 Group ID 所對應的實例 ID。針對有獨立命名空間的實例,該參數為必填。

返回數據

名稱 類型 示例值 描述
Data Struct

指定 Group ID 的連接信息

ConnectionList Array

指定 Group ID 的連接信息

ClientAddr String 30.5.121.**

該消費實例的地址和端口

ClientId String 30.5.121.**@25560#-1999745829#-1737591554#458773089270275

消費實例的 ID

Language String JAVA

消費端語言

RemoteIp String 42.120.74.**

宿主機 IP 或公網 IP

Version String V4_3_6_SNAPSHOT

消費端版本

RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

請求ID

ResultCode String OK

結果碼

ResultMessage String OK

結果描述

示例

請求示例

http(s)://[Endpoint]/?Action=QueryMqSofamqConsumerConnection
&Cell=RZ01A
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共請求參數>

正常返回示例

XML 格式

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <ConnectionList>
        <ClientAddr>30.5.121.**</ClientAddr>
        <Language>JAVA</Language>
        <RemoteIp>42.120.74.**</RemoteIp>
        <Version>V4_3_6_SNAPSHOT</Version>
        <ClientId>30.5.121.**@25560#-1999745829#-1737591554#458773089270275</ClientId>
    </ConnectionList>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON 格式

{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"ConnectionList":[{"ClientAddr":"30.5.121.**","Language":"JAVA","RemoteIp":"42.120.74.**","Version":"V4_3_6_SNAPSHOT","ClientId":"30.5.121.**@25560#-1999745829#-1737591554#458773089270275"}]},"ResultMessage":"OK","ResultCode":"OK"}

錯誤碼

訪問錯誤中心查看更多錯誤碼。