Jump to

• Request
• Response

View Topic Subscriber Groups

get

/management/coherence/cluster/topics/{topicName}/subscriberGroups

Use this endpoint to list the subscriber groups of a topic.

Request

Path Parameters

• topicName: string
  Name of the topic.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that lists topic subscriber groups

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/subscriberGroup"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object subscriberGroup

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/subscriberGroup"
    }
}

Nested Schema : subscriberGroup

Type: object

Show Source

• channelCount(optional): integer(int32)
  Read Only: true

  The channel count.
• channels(optional): object channels
  Additional Properties Allowed: subscriberGroupChannel
• cluster(optional): string
  Read Only: true

  The cluster name.
• filter(optional): string
  Read Only: true

  The filter for the subscriber group.
• name(optional): string
  Read Only: true

  Name of the subscriber group.
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• polledCount(optional): integer(int64)
  Read Only: true

  The polled messages count.
• polledFifteenMinuteRate(optional): number(double)
  Read Only: true

  The polled messages fifteen minute rate.
• polledFiveMinuteRate(optional): number(double)
  Read Only: true

  The polled messages five minute rate.
• polledMeanRate(optional): number(double)
  Read Only: true

  The polled messages mean rate.
• polledOneMinuteRate(optional): number(double)
  Read Only: true

  The polled messages one minute rate.
• service(optional): string
  The topic service name.
• topic(optional): string
  Read Only: true

  Name of the topic.
• transformer(optional): string
  Read Only: true

  The transformer for the subscriber group.
• type(optional): string
  Read Only: true

  Allowed Values: [ "PagedTopicSubscriberGroup" ]

  The type of the MBean

{
    "type":"object",
    "properties":{
        "polledFiveMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages five minute rate.",
            "readOnly":true
        },
        "transformer":{
            "type":"string",
            "description":"The transformer for the subscriber group.",
            "readOnly":true
        },
        "channelCount":{
            "type":"integer",
            "format":"int32",
            "description":"The channel count.",
            "readOnly":true
        },
        "filter":{
            "type":"string",
            "description":"The filter for the subscriber group.",
            "readOnly":true
        },
        "polledMeanRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages mean rate.",
            "readOnly":true
        },
        "polledFifteenMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages fifteen minute rate.",
            "readOnly":true
        },
        "polledOneMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages one minute rate.",
            "readOnly":true
        },
        "polledCount":{
            "type":"integer",
            "format":"int64",
            "description":"The polled messages count.",
            "readOnly":true
        },
        "channels":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/subscriberGroupChannel"
            }
        },
        "service":{
            "type":"string",
            "description":"The topic service name."
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "PagedTopicSubscriberGroup"
            ],
            "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
        },
        "name":{
            "type":"string",
            "description":"Name of the subscriber group.",
            "readOnly":true
        },
        "cluster":{
            "type":"string",
            "description":"The cluster name.",
            "readOnly":true
        }
    }
}

Nested Schema : channels

Type: object

Additional Properties Allowed

Show Source

• object subscriberGroupChannel

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

Nested Schema : subscriberGroupChannel

Type: object

Show Source

• Channel(optional): integer(int32)
  Read Only: true

  The channel.
• Head(optional): string
  Read Only: true

  Head position.
• LastCommittedPosition(optional): string
  Read Only: true

  Last committed position.
• LastCommittedTimestamp(optional): string(date-time)
  Read Only: true

  The last committed position.
• LastPolledTimestamp(optional): string(date-time)
  Read Only: true

  The last polled timestamp.
• OwningSubscriberId(optional): string
  Read Only: true

  The owning subscriber.
• PolledCount(optional): integer(int64)
  Read Only: true

  The polled messages count.
• PolledFifteenMinuteRate(optional): number(double)
  Read Only: true

  The polled messages fifteen minute rate.
• PolledFiveMinuteRate(optional): number(double)
  Read Only: true

  The polled messages five minute rate.
• PolledMeanRate(optional): number(double)
  Read Only: true

  The polled messages mean rate.
• PolledOneMinuteRate(optional): number(double)
  Read Only: true

  The polled messages one minute rate.
• RemainingUnpolledMessages(optional): integer(int64)
  Read Only: true

  The remaining unpolled messages count.

{
    "type":"object",
    "properties":{
        "Channel":{
            "type":"integer",
            "format":"int32",
            "description":"The channel.",
            "readOnly":true
        },
        "Head":{
            "type":"string",
            "description":"Head position.",
            "readOnly":true
        },
        "LastCommittedPosition":{
            "type":"string",
            "description":"Last committed position.",
            "readOnly":true
        },
        "LastCommittedTimestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The last committed position.",
            "readOnly":true
        },
        "LastPolledTimestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The last polled timestamp.",
            "readOnly":true
        },
        "OwningSubscriberId":{
            "type":"string",
            "description":"The owning subscriber.",
            "readOnly":true
        },
        "PolledCount":{
            "type":"integer",
            "format":"int64",
            "description":"The polled messages count.",
            "readOnly":true
        },
        "PolledFifteenMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages fifteen minute rate.",
            "readOnly":true
        },
        "PolledFiveMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages five minute rate.",
            "readOnly":true
        },
        "PolledOneMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages one minute rate.",
            "readOnly":true
        },
        "PolledMeanRate":{
            "type":"number",
            "format":"double",
            "description":"The polled messages mean rate.",
            "readOnly":true
        },
        "RemainingUnpolledMessages":{
            "type":"integer",
            "format":"int64",
            "description":"The remaining unpolled messages count.",
            "readOnly":true
        }
    }
}

Back to Top