Jump to

• Request
• Response

View Federation Coordinator Information

get

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

Use this endpoint to view the status of the federation coordinator for a specific federated service.

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 federation coordinator information

Body ()

Root Schema : federationCoordinator

Type: object

Life-cycle Control for Federation.

Show Source

• coordinatorId(optional): integer
  The federation coordinator node's member Id.
• location(optional): string
  Read Only: true

  The location of the MBean server
• member(optional): string
  Name of the cluster member
• nonFederatedCaches(optional): array nonFederatedCaches
  List of the names of the caches that belong to a Federated Cache Service, but are not being federated.
• pendingOutgoingMessageCount(optional): integer(int64)
  The number of pending outgoing messages.
• responsibility(optional): string
  Read Only: true

  Allowed Values: [ "Coordinator" ]

  The responsibility type
• traceLogging(optional): boolean
  Default Value: false

  True if federation trace logging is on.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Federation" ]

  The type of the MBean

{
    "type":"object",
    "description":"Life-cycle Control for Federation.",
    "properties":{
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Federation"
            ],
            "readOnly":true
        },
        "responsibility":{
            "type":"string",
            "description":"The responsibility type",
            "enum":[
                "Coordinator"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member"
        },
        "coordinatorId":{
            "description":"The federation coordinator node's member Id.",
            "type":"integer"
        },
        "nonFederatedCaches":{
            "description":"List of the names of the caches that belong to a Federated Cache Service, but are not being federated.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "pendingOutgoingMessageCount":{
            "description":"The number of pending outgoing messages.",
            "format":"int64",
            "type":"integer"
        },
        "traceLogging":{
            "default":"false",
            "description":"True if federation trace logging is on.",
            "type":"boolean"
        }
    }
}

Nested Schema : nonFederatedCaches

Type: array

List of the names of the caches that belong to a Federated Cache Service, but are not being federated.

Show Source

• Array of: string

{
    "description":"List of the names of the caches that belong to a Federated Cache Service, but are not being federated.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top