View Topic Subscribers
get
/management/coherence/cluster/topics/{topicName}/subscribers/{subscriberId}
Use this endpoint to view statistics for a subscriber.
Request
Path Parameters
-
subscriberId: string
ID of the subscriber.
-
topicName: string
Name of the topic.
Response
Supported Media Types
- application/json
200 Response
A successful request that returns information about a subscriber
Root Schema : subscriber
Type:
Show Source
object
-
backlog(optional):
integer(int64)
Read Only:
true
The number of outstanding receive requests. -
channelAllocations(optional):
string
Read Only:
true
The subscriber's allocated channels. -
channelCount(optional):
integer(int32)
Read Only:
true
The number of channels the topic has. -
channels(optional):
object channels
Additional Properties Allowed: subscriberChannel
-
cluster(optional):
string
Read Only:
true
The cluster name. -
completeOnEmpty(optional):
boolean
Read Only:
true
A flag indicating whether the subscriber completes receive requests with a null message when the topic is empty. -
converter(optional):
string
Read Only:
true
The optional converter being used to transform messages. -
disconnections(optional):
integer(int64)
Read Only:
true
The number of times this subscriber has disconnected. -
filter(optional):
string
Read Only:
true
The optional filter being used to filter messages. -
id(optional):
integer(int64)
Read Only:
true
The subscriber's identifier. -
maxBacklog(optional):
integer(int64)
Read Only:
true
The maximum allowed backlog of receive requests not yet complete. -
member(optional):
string
Read Only:
true
Name of the cluster member -
nodeId(optional):
integer(int64)
Read Only:
true
The ID of member to which the MBean belongs -
notifications(optional):
integer(int64)
Read Only:
true
The number of channel notifications received. -
polls(optional):
integer(int64)
Read Only:
true
The number of times the subscriber has polled for messages. -
receiveCompletions(optional):
integer(int64)
The number of completed received requests.
-
receivedCount(optional):
integer(int64)
Read Only:
true
The number of elements received. -
receiveEmpty(optional):
integer(int64)
Read Only:
true
The number of empty receive requests. -
receiveErrors(optional):
integer(int64)
Read Only:
true
The number of received requests completed in error. -
serializer(optional):
string
Read Only:
true
The serializer used to deserialize messages. -
service(optional):
string
Read Only:
true
The topic service name. -
state(optional):
integer(int64)
Read Only:
true
The state of the subscriber. -
stateName(optional):
string
Read Only:
true
The subscriber's state. -
subscriberGroup(optional):
string
Read Only:
true
The group the subscriber belongs to, if part of a group. -
topic(optional):
string
Read Only:
true
Name of the topic. -
type(optional):
string
Read Only:
true
Allowed Values:[ "PagedTopicSubscriber" ]
The type of the MBean -
waits(optional):
integer(int64)
Read Only:
true
The number of times the subscriber has had to wait on an empty topic.
Nested Schema : subscriberChannel
Type:
Show Source
object
-
Channel(optional):
integer(int32)
Read Only:
true
The channel. -
Empty(optional):
boolean
Read Only:
true
True if the channel is empty. -
Head(optional):
string
Read Only:
true
Head position. -
LastCommit(optional):
string
Read Only:
true
Last committed position. -
LastReceived(optional):
string
Read Only:
true
Last committed position. -
Owned(optional):
boolean
Read Only:
true
True if the channel is owned by this subscriber.