Jump to

• Request
• Response

Use this endpoint to view a list of topics in the cluster

get

/management/coherence/cluster/services/{serviceName}/topics

Topic names are often used as parameters when performing other topic resource operations.

Request

Path Parameters

• serviceName: string
  Name of the cache service.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns a list of topics

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object topic
  Details of the particular topic.

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

Nested Schema : topic

Type: object

Details of the particular topic.

Show Source

• allowUnownedCommits(optional): array allowUnownedCommits
  Allow unowned commits
• channelCount(optional): object summaryNumber
• elementCalculator(optional): array elementCalculator
  Element calculator.
• name(optional): string
  Name of the topic.
• nodeId(optional): array nodeId
  Topic members.
• pageCapacity(optional): object summaryNumber
• publishedCount(optional): object summaryNumber
• publishedFifteenMinuteRate(optional): object summaryNumber
• publishedFiveMinuteRate(optional): object summaryNumber
• publishedMeanRate(optional): object summaryNumber
• publishedOneMinuteRate(optional): object summaryNumber
• reconnectRetry(optional): object summaryNumber
• reconnectTimeout(optional): object summaryNumber
• reconnectWait(optional): object summaryNumber
• retainConsumed(optional): array retainConsumed
  Retain consumed values.
• service(optional): string
  Name of the service.
• subscriberTimeout(optional): object summaryNumber
• type(optional):
  Allowed Values: [ "PagedTopic" ]

{
    "type":"object",
    "description":"Details of the particular topic.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the topic."
        },
        "nodeId":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            },
            "description":"Topic members."
        },
        "service":{
            "type":"string",
            "description":"Name of the service."
        },
        "type":{
            "enum":[
                "PagedTopic"
            ]
        },
        "retainConsumed":{
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "description":"Retain consumed values."
        },
        "reconnectRetry":{
            "$ref":"#/definitions/summaryNumber"
        },
        "publishedCount":{
            "$ref":"#/definitions/summaryNumber"
        },
        "channelCount":{
            "$ref":"#/definitions/summaryNumber"
        },
        "subscriberTimeout":{
            "$ref":"#/definitions/summaryNumber"
        },
        "allowUnownedCommits":{
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "description":"Allow unowned commits"
        },
        "publishedOneMinuteRate":{
            "$ref":"#/definitions/summaryNumber"
        },
        "pageCapacity":{
            "$ref":"#/definitions/summaryNumber"
        },
        "elementCalculator":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Element calculator."
        },
        "publishedMeanRate":{
            "$ref":"#/definitions/summaryNumber"
        },
        "reconnectTimeout":{
            "$ref":"#/definitions/summaryNumber"
        },
        "publishedFifteenMinuteRate":{
            "$ref":"#/definitions/summaryNumber"
        },
        "publishedFiveMinuteRate":{
            "$ref":"#/definitions/summaryNumber"
        },
        "reconnectWait":{
            "$ref":"#/definitions/summaryNumber"
        }
    }
}

Nested Schema : allowUnownedCommits

Type: array

Allow unowned commits

Show Source

• Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "description":"Allow unowned commits"
}

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"
        }
    }
}

Nested Schema : elementCalculator

Type: array

Element calculator.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Element calculator."
}

Nested Schema : nodeId

Type: array

Topic members.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    },
    "description":"Topic members."
}

Nested Schema : retainConsumed

Type: array

Retain consumed values.

Show Source

• Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "description":"Retain consumed values."
}

Back to Top