API Introduction
Used to query the connection status of clients in a subscription group.
API Restrictions
None.
URl
GET https://[endpoint]/v2/consumer/connection
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
groupName | Yes | url | String | Subscription Group Name |
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 | Map<String/*ConsuemGroup*/, ConsumerConnection> | Data of client connections in a subscription group |
Description of Return Value group
Response Parameter | Parameter Type | Description |
connectionSet | HashSet<Connection> | Connection list |
subscriptionTable | ConcurrentMap<String, SubscriptionData> | Subscription Group Data |
consumeType | ConsumeType | Consumption Type CONSUME_ACTIVELY("PULL") CONSUME_PASSIVELY("PUSH") |
messageModel | MessageModel | Consumption Mode BROADCASTING("BROADCASTING") CLUSTERING("CLUSTERING") |
Description of Return Value Connection
Response Parameter | Parameter Type | Description |
clientId | String | Client Instance ID |
clientAddr | String | Client Address |
language | List | Client Language JAVA((byte)0), CPP((byte)1), DOTNET((byte)2), PYTHON((byte)3), DELPHI((byte)4), ERLANG((byte)5), RUBY((byte)6), OTHER((byte)7), HTTP((byte)8), GO((byte)9), PHP((byte)10) |
version | List | Version No. |
Description of Return Value SubscriptionData
Response Parameter | Parameter Type | Description |
topic | String | Topic |
subString | String | Broker name |
tagsSet | List | Tag List |
codeSet | List | Code List |
subversion | Long | Subscription Timestamp |
Sample Request
GET https://[endpoint]/v2/consumer/connection?prodInstId=70687660456281088&groupName=group
Examples of a Successful Response
{
"returnObj":{
"data":{
"group":{
"connectionSet":[
{
"clientId":"5.5.148.141@test_instance",
"clientAddr":"192.168.71.1:52369",
"language":"JAVA",
"version":297
}
],
"subscriptionTable":{
"%RETRY%group":{
"classFilterMode":false,
"topic":"%RETRY%group",
"subString":"*",
"tagsSet":[
],
"codeSet":[
],
"subVersion":1661916951262,
"expressionType":null,
"filterClassSource":null
},
"test":{
"classFilterMode":false,
"topic":"test",
"subString":"*",
"tagsSet":[
],
"codeSet":[
],
"subVersion":1661916951326,
"expressionType":null,
"filterClassSource":null
}
},
"consumeType":"CONSUME_PASSIVELY",
"messageModel":"CLUSTERING",
"consumeFromWhere":"CONSUME_FROM_FIRST_OFFSET"
}
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}