Jump to

• Request
• Response

View Topic Channels

get

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

Use this endpoint to list the channels 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 channels

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "channels":{
                        "type":"object",
                        "additionalProperties":{
                            "$ref":"#/definitions/topicChannel"
                        }
                    },
                    "nodeId":{
                        "type":"integer",
                        "format":"int64",
                        "description":"The ID of member to which the topic channels belong",
                        "readOnly":true
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "channels":{
                "type":"object",
                "additionalProperties":{
                    "$ref":"#/definitions/topicChannel"
                }
            },
            "nodeId":{
                "type":"integer",
                "format":"int64",
                "description":"The ID of member to which the topic channels belong",
                "readOnly":true
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• channels(optional): object channels
  Additional Properties Allowed: topicChannel
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the topic channels belong

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/topicChannel"
            }
        },
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the topic channels belong",
            "readOnly":true
        }
    }
}

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