REST API Reference for Managing Oracle Coherence

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(required): string

Name of the cache service.

Response

Supported Media Types

application/json

200 Response

A successful request that returns a list of topics

Root Schema : schema

Type: object

Show Source

items: 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: array allowUnownedCommits

Allow unowned commits
channelCount: object summaryNumber
elementCalculator: array elementCalculator

Element calculator.
name: string

Name of the topic.
nodeId: array nodeId

Topic members.
pageCapacity: object summaryNumber
publishedCount: object summaryNumber
publishedFifteenMinuteRate: object summaryNumber
publishedFiveMinuteRate: object summaryNumber
publishedMeanRate: object summaryNumber
publishedOneMinuteRate: object summaryNumber
reconnectRetry: object summaryNumber
reconnectTimeout: object summaryNumber
reconnectWait: object summaryNumber
retainConsumed: array retainConsumed

Retain consumed values.
service: string

Name of the service.
subscriberTimeout: object summaryNumber
type:

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: integer(int64)
count: integer(int64)
max: integer(int64)
min: integer(int64)
sum: 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."
}