接口介绍
查询消息服务订阅组的消息消费堆积信息。
接口约束
无。
URl
GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/accumulate
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
prodInstId | 是 | url | String | 实例ID |
groupName | 是 | url | String | 订阅组名字 |
topicName | 是 | url | String | Topic名字 |
响应参数
响应参数 | 参数类型 | 描述 |
---|---|---|
statusCode | String | 接口系统层面状态码。成功:800,失败:900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
---|---|---|
total | Integer | 总数 |
rows | List | 订阅组堆积信息列表 |
返回值rows参数说明
响应参数 | 参数类型 | 描述 |
---|---|---|
diff | Long | 堆积量 |
total | Long | 总消息数 |
consumedTotal | Long | 已消费数 |
retryNums | Long | 重试消息数 |
groupName | String | 订阅组名称 |
brokerName | String | Broker名称 |
topicName | String | 主题名称 |
outTps | Double | 消费tps |
outTotalMsgToday | Long | 今日总消息数 |
offSetDiff | Long | 偏移量差值 |
notAckMsgNum | Long | 未签收消息数 |
notAckMsgTime | Long | 未签收时间 |
notConsumeMsgTime | Long | 未消费时间 |
请求示例
GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/accumulate?prodInstId=70687660456281088&groupName=group&topicName=test
响应成功示例
{
"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": "...",
"statusCode": "900"
}