使用AMQP服务端订阅时,调用该接口查询某个消费组的状态,包括在线客户端信息、消息消费速率、消息堆积数、最近消息消费时间。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryConsumerGroupStatus | 系统规定参数。取值:QueryConsumerGroupStatus。 |
GroupId | String | 是 | nJRaJPn5U1JITGf****** | 消费组ID。调用CreateConsumerGroup创建消费组成功后,会返回消费组ID。您可以调用QueryConsumerGroupList按消费组名称查询消费组ID,也可以在物联网平台控制台对应实例下,选择消息转发>服务端订阅>消费组列表,查看消费组ID。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccumulatedConsumeCountPerMinute | Integer | 10 | 消费组堆积消息消费速率,单位:条/分钟。 |
AccumulationCount | Integer | 13 | 消费组消息堆积数。 |
ClientConnectionStatusList | Array of ConsumerGroupClientConnectionInfo | 消费组的在线客户端信息,请参见ConsumerGroupClientConnectionInfo。 |
|
ConsumerGroupClientConnectionInfo | |||
AccumulatedConsumeCountPerMinute | Integer | 10 | 消费组的单个客户端堆积消息消费速率,单位:条/分钟。 |
ClientId | String | 868575026****** | 在线客户端ID。 |
ClientIpPort | String | 192.168.1.2:36918 | 在线客户端IP和端口。 |
OnlineTime | Long | 1591240546649 | 在线客户端的最后上线时间。取值为1970年01月01日00时00分00秒000毫秒以来的毫秒数。 |
RealTimeConsumeCountPerMinute | Integer | 5 | 消费组的单个客户端实时消息消费速率,单位:条/分钟。 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
ConsumerSpeed | Integer | 14 | 消费组消息消费速率,单位:条/分钟。 |
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
LastConsumerTime | String | 2020-05-29T03:37:56.000Z | 最近消息消费时间。为UTC时间,以毫秒计,格式为“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。 |
RealTimeConsumeCountPerMinute | Integer | 14 | 消费组实时消息消费速率,单位:条/分钟。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupStatus
&GroupId=nJRaJPn5U1JITGf******
&<公共请求参数>
正常返回示例
XML
格式
<QueryConsumerGroupStatusResponse>
<ClientConnectionStatusList>
<ConsumerGroupClientConnectionInfo>
<ClientId>12345-1</ClientId>
<AccumulatedConsumeCountPerMinute>8</AccumulatedConsumeCountPerMinute>
<OnlineTime>1627624830193</OnlineTime>
<ClientIpPort>192.168.1.2:55545</ClientIpPort>
<RealTimeConsumeCountPerMinute>16</RealTimeConsumeCountPerMinute>
</ConsumerGroupClientConnectionInfo>
<ConsumerGroupClientConnectionInfo>
<ClientId>12345-0</ClientId>
<AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
<OnlineTime>1627624829763</OnlineTime>
<ClientIpPort>192.168.1.2:55526</ClientIpPort>
<RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
</ConsumerGroupClientConnectionInfo>
</ClientConnectionStatusList>
<RequestId>4EC250E4-70CE-546E-9D4A-31D06E04EAD8</RequestId>
<AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
<Success>true</Success>
<RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
<AccumulationCount>26</AccumulationCount>
<ConsumerSpeed>14</ConsumerSpeed>
</QueryConsumerGroupStatusResponse>
JSON
格式
{
"ClientConnectionStatusList": {
"ConsumerGroupClientConnectionInfo": [
{
"ClientId": "12345-1",
"AccumulatedConsumeCountPerMinute": 8,
"OnlineTime": 1627624830193,
"ClientIpPort": "192.168.1.2:55545",
"RealTimeConsumeCountPerMinute": 16
},
{
"ClientId": "12345-0",
"AccumulatedConsumeCountPerMinute": 10,
"OnlineTime": 1627624829763,
"ClientIpPort": "192.168.1.2:55526",
"RealTimeConsumeCountPerMinute": 14
}
]
},
"RequestId": "4EC250E4-70CE-546E-9D4A-31D06E04EAD8",
"AccumulatedConsumeCountPerMinute": 10,
"Success": true,
"RealTimeConsumeCountPerMinute": 14,
"AccumulationCount": 26,
"ConsumerSpeed": 14
}