Jump to

• Request
• Response

View Topic Member Information

get

/management/coherence/cluster/topics/{topicName}/members/{memberIdentifier}

Use this endpoint to view information about topic on a specific member.

Request

Path Parameters

• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.
• 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 topic

Body ()

Root Schema : topicMember

Type: object

Show Source

• allowUnownedCommits(optional): boolean
  Read Only: true

  True if the topic allows commits for a position in a channel by subscribers that do not own the channel.
• channelCount(optional): integer(int32)
  Read Only: true

  The number of channels that this topic has.
• channels(optional): object channels
  Additional Properties Allowed: topicChannel
• cluster(optional): string
  Read Only: true

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

  The calculator name used to calculate element sizes.
• name(optional): string
  Read Only: true

  The name of the topic
• nodeId(optional): integer(int64)
  Read Only: true

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

  the capacity of a page in the topic.
• publishedCount(optional): integer(int64)
  Read Only: true

  The published messages count.
• publishedFifteenMinuteRate(optional): number(double)
  Read Only: true

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

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

  the published messages mean rate.
• publishedOneMinuteRate(optional): number(double)
  Read Only: true

  the published messages one-minute rate.
• reconnectRetry(optional): integer(int64)
  Read Only: true

  The amount of time publishers and subscribers will wait between attempts to reconnect after being disconnected.
• reconnectTimeout(optional): integer(int64)
  Read Only: true

  The maximum amount of time publishers and subscribers will attempt to reconnect after being disconnected
• reconnectWait(optional): integer(int64)
  Read Only: true

  The maximum amount of time publishers and subscribers will wait before attempting to reconnect after being disconnected.
• retainConsumed(optional): boolean
  Read Only: true

  Determine whether to retain consumed values.
• service(optional): string
  Read Only: true

  The topic service name.
• subscriberTimeout(optional): integer(int64)
  Read Only: true

  Number of milliseconds within which a subscriber must issue a heartbeat or be forcefully considered closed.
• type(optional): string
  Read Only: true

  Allowed Values: [ "PagedTopic" ]

  The type of the MBean

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "PagedTopic"
            ],
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the topic",
            "readOnly":true
        },
        "service":{
            "type":"string",
            "description":"The topic service name.",
            "readOnly":true
        },
        "cluster":{
            "type":"string",
            "description":"The cluster name.",
            "readOnly":true
        },
        "retainConsumed":{
            "type":"boolean",
            "description":"Determine whether to retain consumed values.",
            "readOnly":true
        },
        "reconnectRetry":{
            "type":"integer",
            "format":"int64",
            "description":"The amount of time publishers and subscribers will wait between attempts to reconnect after being disconnected.",
            "readOnly":true
        },
        "publishedCount":{
            "type":"integer",
            "format":"int64",
            "description":"The published messages count.",
            "readOnly":true
        },
        "channelCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of channels that this topic has.",
            "readOnly":true
        },
        "subscriberTimeout":{
            "type":"integer",
            "format":"int64",
            "description":"Number of milliseconds within which a subscriber must issue a heartbeat or be forcefully considered closed.",
            "readOnly":true
        },
        "allowUnownedCommits":{
            "type":"boolean",
            "description":"True if the topic allows commits for a position in a channel by subscribers that do not own the channel.",
            "readOnly":true
        },
        "publishedOneMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"the published messages one-minute rate.",
            "readOnly":true
        },
        "pageCapacity":{
            "type":"integer",
            "format":"int64",
            "description":"the capacity of a page in the topic.",
            "readOnly":true
        },
        "elementCalculator":{
            "type":"string",
            "description":"The calculator name used to calculate element sizes.",
            "readOnly":true
        },
        "publishedMeanRate":{
            "type":"number",
            "format":"double",
            "description":"the published messages mean rate.",
            "readOnly":true
        },
        "reconnectTimeout":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum amount of time publishers and subscribers will attempt to reconnect after being disconnected",
            "readOnly":true
        },
        "publishedFifteenMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages fifteen minute rate.",
            "readOnly":true
        },
        "publishedFiveMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages five minute rate.",
            "readOnly":true
        },
        "reconnectWait":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum amount of time publishers and subscribers will wait before attempting to reconnect after being disconnected.",
            "readOnly":true
        },
        "channels":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/topicChannel"
            }
        }
    }
}

Nested Schema : channels

Type: object

Additional Properties Allowed

Show Source

• object topicChannel

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

Nested Schema : topicChannel

Type: object

Show Source

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

  The channel.
• PublishedCount(optional): integer(int64)
  Read Only: true

  The published messages count.
• PublishedFifteenMinuteRate(optional): number(double)
  Read Only: true

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

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

  The published messages mean rate.
• PublishedOneMinuteRate(optional): number(double)
  Read Only: true

  The published messages one minute rate.
• Tail(optional): string
  Read Only: true

  Tail position.

{
    "type":"object",
    "properties":{
        "Channel":{
            "type":"integer",
            "format":"int32",
            "description":"The channel.",
            "readOnly":true
        },
        "PublishedCount":{
            "type":"integer",
            "format":"int64",
            "description":"The published messages count.",
            "readOnly":true
        },
        "PublishedFifteenMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages fifteen minute rate.",
            "readOnly":true
        },
        "PublishedFiveMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages five minute rate.",
            "readOnly":true
        },
        "PublishedOneMinuteRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages one minute rate.",
            "readOnly":true
        },
        "PublishedMeanRate":{
            "type":"number",
            "format":"double",
            "description":"The published messages mean rate.",
            "readOnly":true
        },
        "Tail":{
            "type":"string",
            "description":"Tail position.",
            "readOnly":true
        }
    }
}

Back to Top