使用 OnsConsumerGetConnection 查询指定 Group ID 下当前客户端的连接情况。

本接口一般用于判断指定 Group ID 的消费者是否在线,并获取详细的客户端连接的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsConsumerGetConnection

系统规定参数。取值:OnsConsumerGetConnection。

GroupId String GID_test_consumer_id

需查询的 Group ID

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

返回数据

名称 类型 示例值 描述
Data

指定 Group ID 的连接信息

ConnectionList

指定 Group ID 的连接信息

ConnectionDo

指定 Group ID 的连接信息

ClientAddr String 30.5.121.**

该消费实例的地址和端口

ClientId String 30.5.121.**@24813#-1999745829#-1737591554#453111174894656

消费实例的 ID

Language String JAVA

消费端语言

Version String V4_3_6

消费端版本

RequestId String DE4140C7-F42D-473D-A5FF-B1E3169245F2

为公共参数,每个请求的 ID 都是唯一的

示例

请求示例


http(s)://[Endpoint]/?Action=OnsConsumerGetConnection
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<OnsConsumerGetConnectionResponse>
      <Data>
            <ConnectionList>
                  <ConnectionDo>
                        <ClientAddr>30.5.121.**</ClientAddr>
                        <Language>JAVA</Language>
                        <Version>V4_3_6</Version>
                        <ClientId>30.5.121.**@24813#-1999745829#-1737591554#453111174894656</ClientId>
                  </ConnectionDo>
            </ConnectionList>
      </Data>
      <RequestId>DE4140C7-F42D-473D-A5FF-B1E3169245F2</RequestId>
</OnsConsumerGetConnectionResponse>

JSON 格式

{
	"Data":{
		"ConnectionList":{
			"ConnectionDo":[
				{
					"ClientAddr":"30.5.121.**",
					"Language":"JAVA",
					"ClientId":"30.5.121.**@24813#-1999745829#-1737591554#453111174894656",
					"Version":"V4_3_6"
				}
			]
		}
	},
	"RequestId":"DE4140C7-F42D-473D-A5FF-B1E3169245F2"
}

错误码

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