查询订阅组的消息消费堆积
更新时间 2025-11-27 16:34:37
最近更新时间: 2025-11-27 16:34:37
接口功能介绍
查询订阅组的消息消费堆积
接口约束
无
URI
GET /v3/consumer/accumulate
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| groupName | 是 | String | 订阅组名字 | ||
| topicName | 是 | String | Topic名字 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | 800 | |
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数。 | 1 | |
| rows | Array of Objects | 消费组消息统计信息列表。 | rows | |
| 表 rows |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diff | Integer | 差值 | 0 | |
| total | Integer | 消息总数 | 27 | |
| consumedTotal | Integer | 已消费消息总数 | 27 | |
| retryNums | Integer | 重试次数 | 0 | |
| groupName | String | 消费组名称 | group | |
| brokerName | String | Broker名称 | mq_test_broker_1 | |
| topicName | String | 主题名称 | test | |
| outTps | Integer | 出消息TPS | 0 | |
| outTotalMsgToday | Integer | 今日出消息总数 | 0 | |
| offSetDiff | Integer | 偏移量差值 | 0 | |
| notAckMsgNum | Integer | 未确认消息数 | 0 | |
| notAckMsgTime | Integer | 未确认消息时长 | 0 | |
| notConsumeMsgTime | Integer | 未消费消息时长 | 0 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/consumer/accumulate?prodInstId=70687660456281088&groupName=group&topicName=test
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"returnObj":{
"total":1,
"rows":[
{
"diff":0,
"total":27,
"consumedTotal":27,
"retryNums":0,
"groupName":"group",
"brokerName":"mq_test_broker_1",
"topicName":"test",
"outTps":0,
"outTotalMsgToday":0,
"offSetDiff":0,
"notAckMsgNum":0,
"notAckMsgTime":0,
"notConsumeMsgTime":0
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
