消息队列 RocketMQ版
消息队列 RocketMQ版
消息队列 RocketMQ版
文档指南
请输入
产品动态
用户指南
实例管理
后台任务管理
Terraform
RocketMQ Agent
API 参考
实例管理
Topic管理
Group管理
消息查询
死信队列
密钥管理
风险巡检
白名单管理
终端节点服务
SDK 参考
RocketMQ 5.x
RocketMQ 4.x
RocketMQ 管控面SDK
最佳实践
- 文档首页
消息队列 RocketMQ版API 参考Group管理DescribeConsumedClients - 查看 Group 连接的客户端信息
复制全文
下载 pdfDescribeConsumedClients - 查看 Group 连接的客户端信息
文档反馈
问问助手调用 DescribeConsumedClients 接口查看 Group 连接的客户端信息。
使用说明
此接口用于查看指定 Group 连接的所有客户端信息，包括客户端 ID、消息堆积量等。
注意事项
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
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，可设置为：
- Diff：根据消息堆积量排序。
- ClientId：根据客户端 ID 排序。
SortOrder string 可选 示例值：Asc
客户端连接信息信息的排序方式。默认为 Asc。
- Asc：升序
- Desc：降序
返回参数
ConnectionCount integer 示例值：1
消费客户端数量。
ConsumedClientsInfo object[] 示例值：/
符合查询条件的消费客户端列表。
ClientAddress string 示例值：10.60.****
该消费者实例的地址和端口。
ClientId string 示例值：192.***.**@16****
该消费者实例的 ID。
Language string 示例值：JAVA
消费者应用的开发语言。
Version string 示例值：V4_8_0
消费端版本。
Diff long 示例值：10
消息堆积量。
请求示例
POST /?Action=DescribeConsumedClients&Version=2023-01-01 HTTP/1.1
Host: rocketmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260112T082926Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260112/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceId": "rocketmq-cnai1f0c29ca****",
"GroupId": "GID_test",
"PageNumber": 1,
"PageSize": 10
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260112162952118114013057D4BA06",
"Action": "DescribeConsumedClients",
"Version": "2023-01-01",
"Service": "RocketMQ",
"Region": "cn-beijing"
},
"Result": {
"ConnectionCount": 1,
"ConsumedClientsInfo": [
{
"ClientAddress": "10.60.****",
"ClientId": "192.***.**@16****",
"Language": "JAVA",
"Version": "V4_8_0",
"Diff": 10
}
]
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
状态码 | 错误码 | 错误信息 | 说明 |
200 | OK | OK | 成功。 |
400 | NotModifiedParameter | The resource was not changed. | 未变更任何配置。 |
400 | InvalidParameter | The specified parameter %s is not valid. | 参数值%s无效，请检查后重试。 |
400 | UnsupportedParameter | The specified parameter %s is unsupported. | 不支持%s参数。 |
400 | MissingParameter | The request body is missing a required parameter %s. | 缺少%s参数。 |
400 | OperationDenied_InvalidRequest | The request that you specified is not valid. | 请求异常，请检查后重试。 |
400 | InvalidTopicName_AlreadyExists | The specified topic name already exists. | Topic 名称已存在。 |
400 | InvalidGroupId_AlreadyExists | The specified group name already exists. | Group 名称已存在。 |
400 | QuotaExceeded_InstanceNumber | The number of instances exceeds the limit. | 实例数量超出上限。 |
400 | QuotaExceeded_AuthKeyNumber | The number of authKeys exceeds the limit. | 密钥数量超出上限。 |
400 | QuotaExceeded_TopicNumber | The number of topic exceeds the limit. | Topic 数量超出上限。 |
400 | QuotaExceeded_GroupNumber | The number of group exceeds the limit. | Group 数量超出上限。 |
400 | QuotaExceeded_QueueNumber | The number of queue exceeds the limit. | 队列数量超出上限。 |
400 | InvalidPara | The specified parameter is not valid. | 参数值无效。 |
400 | OperationDenied.InvalidRequest | The request that you specified is not valid. | 请求异常，请检查后重试。 |
403 | OperationDenied_AccountNotAuthorized | You are not authorized to perform this operation. | 您不具备相关权限，请授权或切换账号后重试。 |
403 | OperationDenied_InternetAccessEnabled | Internet access is enabled for the instance. | 该实例已开启公网访问方式。 |
403 | OperationDenied_InternetAccessDisabled | Internet access is disabled for the instance. | 该实例未开启公网访问方式。 |
403 | OperationDenied_ResourceOccupied | The resource is busy now, please try again later. | 资源繁忙，可能由于指定资源正在被访问或回收。 |
403 | OperationDenied_InvalidInstanceStatus | The operation is not valid for the current status of the instance. | 当前实例状态不允许执行该操作。 |
403 | OperationDenied_InstanceNotEmpty | The instance that you tried to delete is not empty. | 期望删除的实例资源不为空。 |
403 | OperationDenied_TaskIsRunning | An operation is currently in progress. Try again later. | 后台任务正在运行中，请稍后再试。 |
403 | OperationDenied_VersionUnsupported | The current instance version does not support this operation.Please upgrade the instance and try again. | 当前实例版本不支持指定操作，请升级实例后再试。 |
403 | OperationDenied.AccountNotAuthorized | You are not authorized to perform this operation. | 您不具备相关权限，请授权或切换账号后重试。 |
403 | OperationDenied.ResourceOccupied | The resource is busy now, please try again later. | 资源繁忙，可能由于指定资源正在被访问或回收。 |
403 | OperationDenied.InvalidInstanceStatus | The operation is not valid for the current status of the instance. | 当前实例状态不允许执行该操作。 |
403 | OperationDenied.VersionUnsupported | The current instance version does not support this operation.Please upgrade the instance and try again. | 当前实例版本不支持指定操作，请升级实例后再试。 |
404 | InvalidInstanceId_NotFound | The specified Instance ID does not exist. | 实例不存在。 |
404 | InvalidTopicName_NotFound | The specified topic does not exist. | Topic 不存在。 |
404 | InvalidGroup_NotFound | The specified group does not exist. | Group 不存在。 |
404 | InvalidAccessKeyId_NotFound | The specified accessKey does not exist. | AccessKey 不存在。 |
404 | InvalidMessageId_NotFound | The message ID does not exist in the instance %s. | Message ID 不存在。 |
404 | InvalidEip_NotFound | The specified EIP does not exist. | EIP 不存在。 |
404 | InvalidInstanceId.NotFound | The specified Instance ID does not exist. | 实例不存在。 |
404 | InvalidGroup.NotFound | The specified group does not exist. | Group 不存在。 |
500 | InternalError | The request failed due to some unknown error, exception or failure. | 内部错误，请稍后再试。 |
500 | ResourceIsBusy | The resource is busy now, please try again later. | 资源繁忙，可能由于指定资源正在被访问或回收。 |
500 | ServerInternalError | The request failed due to some unknown error, exception or failure. | 服务内部错误。 |
503 | ServiceUnavailable | The request failed due to a temporary failure of the server. | 当前服务暂时不可用。 |
最近更新时间：2026.02.13 18:31:53
这个页面对您有帮助吗？
有用
有用
无用
无用