判断指定 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"}

错误码

访问错误中心查看更多错误码。