API Introduction
Used to query the accumulated messages of a subscription group.
API Restrictions
None.
URl
GET https://[endpoint]/v2/consumer/accumulate
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
groupName | Yes | url | String | Subscription Group Name |
topicName | Yes | url | String | Topic Name |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Description of Return Value returnObj
Response Parameter | Parameter Type | Description |
total | Integer | Total |
rows | List | Accumulated Message List of Subscription Group |
Description of Return Value rows
Response Parameter | Parameter Type | Description |
diff | Long | Accumulation Volume |
total | Long | Total Number of Messages |
consumedTotal | Long | Number of Consumed Messages |
retryNums | Long | Number of Retried Messages |
groupName | String | Subscription Group Name |
brokerName | String | Broker name |
topicName | String | Topic Name |
outTps | Double | Consumption TPS |
outTotalMsgToday | Long | Total Number of Messages for Today |
offSetDiff | Long | Offset Difference |
notAckMsgNum | Long | Number of unacknowledged messages |
notAckMsgTime | Long | Non-acknowledge time |
notConsumeMsgTime | Long | Non-consumption Time |
Sample Request
GET https://[endpoint]/v2/consumer/accumulate?prodInstId=70687660456281088&groupName=group&topicName=test
Examples of a Successful Response
{
"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
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}