Jump to

• Request
• Response

View Topic Subscribers

get

/management/coherence/cluster/services/{serviceName}/topics/{topicName}/subscribers/{subscriberId}

Use this endpoint to view statistics for a subscriber.

Request

Path Parameters

• serviceName: string
  Name of the cache service.
• subscriberId: string
  ID of the subscriber.
• topicName: string
  Name of the topic.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns information about a subscriber

Body ()

Root Schema : subscriber

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "maxBacklog":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum allowed backlog of receive requests not yet complete.",
            "readOnly":true
        },
        "channelCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of channels the topic has.",
            "readOnly":true
        },
        "receiveCompletions":{
            "type":"integer",
            "format":"int64",
            "description":"The number of completed received requests."
        },
        "stateName":{
            "type":"string",
            "description":"The subscriber's state.",
            "readOnly":true
        },
        "waits":{
            "type":"integer",
            "format":"int64",
            "description":"The number of times the subscriber has had to wait on an empty topic.",
            "readOnly":true
        },
        "receiveErrors":{
            "type":"integer",
            "format":"int64",
            "description":"The number of received requests completed in error.",
            "readOnly":true
        },
        "subscriberGroup":{
            "type":"string",
            "description":"The group the subscriber belongs to, if part of a group.",
            "readOnly":true
        },
        "channelAllocations":{
            "type":"string",
            "description":"The subscriber's allocated channels.",
            "readOnly":true
        },
        "channels":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/subscriberChannel"
            }
        },
        "polls":{
            "type":"integer",
            "format":"int64",
            "description":"The number of times the subscriber has polled for messages.",
            "readOnly":true
        },
        "receiveEmpty":{
            "type":"integer",
            "format":"int64",
            "description":"The number of empty receive requests.",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "PagedTopicSubscriber"
            ],
            "readOnly":true
        },
        "filter":{
            "type":"string",
            "description":"The optional filter being used to filter messages.",
            "readOnly":true
        },
        "state":{
            "type":"integer",
            "format":"int64",
            "description":"The state of the subscriber.",
            "readOnly":true
        },
        "disconnections":{
            "type":"integer",
            "format":"int64",
            "description":"The number of times this subscriber has disconnected.",
            "readOnly":true
        },
        "converter":{
            "type":"string",
            "description":"The optional converter being used to transform messages.",
            "readOnly":true
        },
        "backlog":{
            "type":"integer",
            "format":"int64",
            "description":"The number of outstanding receive requests.",
            "readOnly":true
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The subscriber's identifier.",
            "readOnly":true
        },
        "completeOnEmpty":{
            "type":"boolean",
            "description":"A flag indicating whether the subscriber completes receive requests with a null message when the topic is empty.",
            "readOnly":true
        },
        "receivedCount":{
            "type":"integer",
            "format":"int64",
            "description":"The number of elements received.",
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "notifications":{
            "type":"integer",
            "format":"int64",
            "description":"The number of channel notifications received.",
            "readOnly":true
        },
        "serializer":{
            "type":"string",
            "description":"The serializer used to deserialize messages.",
            "readOnly":true
        },
        "service":{
            "type":"string",
            "description":"The topic service name.",
            "readOnly":true
        },
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "topic":{
            "type":"string",
            "description":"Name of the topic.",
            "readOnly":true
        },
        "cluster":{
            "type":"string",
            "description":"The cluster name.",
            "readOnly":true
        }
    }
}

Nested Schema : channels

Type: object

Additional Properties Allowed

Show Source

• object subscriberChannel

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/subscriberChannel"
    }
}

Nested Schema : subscriberChannel

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Channel":{
            "type":"integer",
            "format":"int32",
            "description":"The channel.",
            "readOnly":true
        },
        "Empty":{
            "type":"boolean",
            "description":"True if the channel is empty.",
            "readOnly":true
        },
        "Head":{
            "type":"string",
            "description":"Head position.",
            "readOnly":true
        },
        "LastCommit":{
            "type":"string",
            "description":"Last committed position.",
            "readOnly":true
        },
        "LastReceived":{
            "type":"string",
            "description":"Last committed position.",
            "readOnly":true
        },
        "Owned":{
            "type":"boolean",
            "description":"True if the channel is owned by this subscriber.",
            "readOnly":true
        }
    }
}

Back to Top