API Introduction
Used to query the list of subscription groups.
API Restrictions
None.
URl
GET https://[endpoint]/v2/group/list
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
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 | Lists of Subscription Groups |
Description of Return Value rows
Response Parameter | Parameter Type | Description |
groupName | Integer | Total |
consumeEnable | List | Lists of Subscription Groups |
consumeFromMinEnable | Boolean | Whether to consume from the minimum offset |
consumeBroadcastEnable | Boolean | Whether to enable broadcasting consumption |
retryQueueNums | Integer | Number of Retry Queues |
retryMaxTimes | Integer | Number of Consumption Retries |
brokerId | Long | BrokerId |
whichBrokerWhenConsumeSlowly | Long | The broker to be switched to in case of slow consumption |
notifyConsumerIdsChangedEnable | Boolean | Whether to notify consumption instance changes |
pullMechanism | Integer | Consumption Mechanism |
firstConsumeMechanism | Integer | First consumption mechanism |
subscribeMap | HashMap<String, SubscribeLimit> | SubscribeLimit: tpsThreshold Topic TPS threshold for subscription group |
brokerName | String | Broker name |
Sample Request
GET https://[endpoint]/v2/group/list?prodInstId=70687660456281088
Examples of a Successful Response
{
"returnObj":{
"total":1,
" rows ":[
{
"groupName":"group",
"consumeEnable":true,
"consumeFromMinEnable":false,
"consumeBroadcastEnable":false,
"retryQueueNums":1,
"retryMaxTimes":16,
"brokerId":0,
"whichBrokerWhenConsumeSlowly":1,
"notifyConsumerIdsChangedEnable":true,
"pullMechanism":1,
"firstConsumeMechanism":1,
"subscribeMap":{
},
"brokerName":"mq_test_broker_1"
}
]
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}