调用OnsConsumerGetConnection查询指定Group ID下当前客户端的连接情况。
使用说明
本接口一般用于在消费异常情况下,获取指定Group ID下客户端的连接信息,通过查看消费者状态初步诊断原因。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例。
API |
Action |
Resource(有命名空间) |
Resource(无命名空间) |
---|---|---|---|
OnsConsumerGetConnection |
mq:QueryInstanceBaseInfo mq:QueryConsumerConnection |
acs:mq:*:*:{instanceId}%{groupId} |
acs:mq:*:*:{groupId} |
调试
您可以在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。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | DE4140C7-F42D-473D-A5FF-B1E31692**** |
公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
Data | Object |
返回参数数据结构。 |
|
ConnectionList | Array of ConnectionDo |
指定Group ID的连接信息。 |
|
ConnectionDo | |||
Version | String | V4_3_6 |
消费端版本。 |
ClientAddr | String | 30.5.121.** |
该消费者实例的地址和端口。 |
Language | String | JAVA |
消费者应用的开发语言。 |
ClientId | String | 30.5.121.**@24813#-1999745829#-1737591554#453111174894656 |
消费者实例的ID。 |
示例
请求示例
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerGetConnection
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/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-B1E31692****</RequestId>
</OnsConsumerGetConnectionResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Data" : {
"ConnectionList" : {
"ConnectionDo" : [ {
"ClientAddr" : "30.5.121.**",
"Language" : "JAVA",
"Version" : "V4_3_6",
"ClientId" : "30.5.121.**@24813#-1999745829#-1737591554#453111174894656"
} ]
}
},
"RequestId" : "DE4140C7-F42D-473D-A5FF-B1E31692****"
}
错误码
访问错误中心查看更多错误码。
控制台操作
除了调用OnsConsumerGetConnection接口,您还可以通过消息队列RocketMQ版控制台查看指定Group ID下客户端的连接情况。具体操作,请参见查看消费者状态。