API Introduction
Used to query the consumption TPS of a subscription group within a specified period.
API Restrictions
None.
URl
GET https://[endpoint]/v2/group/outputTps
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
topicName | Yes | url | String | Topic Name |
brokerName | Yes | url | String | Broker Name |
groupName | Yes | url | String | Subscription Group 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 |
data | Json | TPS Information |
Description of Return Value data
Response Parameter | Parameter Type | Description |
prodInstId | String | Instance ID |
topicName | String | Topic Name |
groupName | String | Subscription Group Name |
tpsVoList | List<TPSVo> | TPS List |
Description of Return Value TPSVo
Response Parameter | Parameter Type | Description |
tps | Double | Tps |
crtTime | Date | Date Timestamp |
Sample Request
GET https://[endpoint]/v2/group/outputTps?prodInstId=70687660456281088&topicName=test&brokerName=brokera&groupName=group
Examples of a Successful Response
{
"returnObj":{
"data":{
"prodInstId":"mq_test",
"topicName":"test",
"groupName":"group",
"tpsVoList":[
{
"tps":0,
"crtTime":1661945340329
},
{
"tps":0,
"crtTime":1661945360495
},
{
"tps":0,
"crtTime":1661945380388
}
]
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}