Jump to

• Request
• Response

View Topic Information

get

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

Use this endpoint to view information about a topir.

Request

Path Parameters

• topicName: string
  Name of the topic.

Query Parameters

• collector: string
  The collector to use for aggregation

  Allowed Values: [ "all", "avg", "count", "list", "max", "min", "set", "sum", "intsummary", "longsummary", "doublesummary" ]
• role: string
  The data from cluster member belonging to the role will be included in the response

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns information about a topic

Body ()

Root Schema : topicAggregate

Type: object

Show Source

• elementCalculator(optional): string
  Element calculator that calculates size of an element based on the size of the serialized binary value.
• name(optional): string
  Name of the topic.
• reconnectRetry(optional): object summaryNumber
• retainConsumed(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the topic."
        },
        "reconnectRetry":{
            "$ref":"#/definitions/summaryNumber"
        },
        "retainConsumed":{
            "type":"boolean"
        },
        "elementCalculator":{
            "type":"string",
            "description":"Element calculator that calculates size of an element based on the size of the serialized binary value."
        }
    }
}

Nested Schema : summaryNumber

Type: object

Show Source

• average(optional): integer(int64)
• count(optional): integer(int64)
• max(optional): integer(int64)
• min(optional): integer(int64)
• sum(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "sum":{
            "type":"integer",
            "format":"int64"
        },
        "average":{
            "type":"integer",
            "format":"int64"
        },
        "min":{
            "type":"integer",
            "format":"int64"
        },
        "max":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top