You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /
  • 消息队列 RocketMQ版

DescribeConsumedClients

最近更新时间：2024.03.06 16:49:23

首次发布时间：2023.07.12 16:22:34

我的收藏

调用 DescribeConsumedClients 接口查看 Group 连接的客户端信息。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

使用说明

此接口用于查看指定 Group 连接的所有客户端信息，包括客户端 ID、消息堆积量等。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-cnai1f0c29ca****

实例 ID。

GroupId

String

是

GID_test

根据 Group 的 ID 筛选。支持模糊查询。

TopicName

String

是

test

Group 订阅的 Topic 名称。
未指定此参数时，返回指定 Group 订阅的所有 Topic 信息。

PageNumber

Integer

是

1

列表的页码，最小值为 1。

PageSize

Integer

是

10

列表中每一页的条目数量，取值范围为 1~100。

SortBy

String

否

Diff

客户端信息排序字段。默认为 Diff，可设置为：

  • Diff：根据消息堆积量排序。
  • ClientId：根据客户端 ID 排序。

SortOrder

String

否

Asc

客户端连接信息信息的排序方式。默认为 Asc。

  • Asc：升序
  • Desc：降序

响应参数

参数

参数类型

示例值

说明

ConnectionCount

Integer

1

消费客户端数量

ConsumedClientsInfo

Array of ConsumedClientInfoObject

[ { "ClientAddress": "100.xx.xx.xx:61377", "ClientId": "10.xx.x.x@16786973xxxx4", "Diff": 0, "Language": "JAVA", "Version": "V4_8_0" } ]

符合查询条件的消费客户端列表。详细说明请参考ConsumedClientInfoObject。

示例

请求示例

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"
            }
        ]
    }
}