调用 DescribeConsumedClients 接口查看 Group 连接的客户端信息。
此接口用于查看指定 Group 连接的所有客户端信息，包括客户端 ID、消息堆积量等。
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeConsumedClients | 要执行的操作，取值：DescribeConsumedClients。 |
Version | String | 是 | 2023-01-01 | API的版本，取值：2023-01-01。 |
InstanceId | String | 是 | rocketmq-cnai1f0c29ca**** | 实例 ID。 |
GroupId | String | 是 | GID_test | 根据 Group 的 ID 筛选。支持模糊查询。 |
PageNumber | Integer | 是 | 1 | 列表的页码，最小值为 1。 |
PageSize | Integer | 是 | 10 | 列表中每一页的条目数量，取值范围为 1~100。 |
SortBy | String | 否 | Diff | 客户端信息排序字段。默认为 Diff，可设置为：
|
SortOrder | String | 否 | Asc | 客户端连接信息信息的排序方式。默认为 Asc。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
ConnectionCount | Integer | 1 | 消费客户端数量。 |
ConsumedClientsInfo | Array of Object | / | 符合查询条件的消费客户端列表。 |
POST /?Action=DescribeConsumedClients&Version=2023-01-01 HTTP/1.1 Content-Type: application/json Host: rocketmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "rocketmq-cnai81fd122a****", "PageNumber":1, "PageSize": 10, "GroupId": "GID_test", "TopicName": "test" }
{ "ResponseMetadata": { "RequestId": "20230508202454323F395741F88148086F", "Action": "DescribeConsumedClients", "Version": "2023-01-01", "Service": "RocketMQ", "Region": "cn-shanghai" }, "Result": { "ConnectionCount": 1, "ConsumedClientsInfo": [ { "ClientAddress": "100.xx.xx.xx:61377", "ClientId": "10.xx.x.x@167869737xxxx", "Diff": 0, "Language": "JAVA", "Version": "V4_8_0" } ] } }
公共错误码请参见公共错误码文档。