Jump to

• Request
• Response

Retrieve Cluster Role

get

/services/{version}/installation/cluster/role/{member}

Required Role: Security

Retrieve a member's role in the OGG cluster

Request

Path Parameters

• member(required): string
  Minimum Length: 1

  Maximum Length: 4095

  Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$

  Name of the OGG Cluster member.

• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Cluster role returned

Body ()

Root Schema : Oracle GoldenGate Cluster Membership - Cluster Member Role

Type: object

Title: Oracle GoldenGate Cluster Membership - Cluster Member Role

Details of the role that a cluster member plays

Show Source

• $schema:
  Allowed Values: [ "ogg:clusterRole" ]
• current: string
  Allowed Values: [ "initialized", "standalone", "voter", "backup", "regionPrimary", "primary" ]

  Member role
• memberName: string
  Minimum Length: 1

  Maximum Length: 4095

  Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$

  The name of the cluster member
• target: string
  Allowed Values: [ "initialized", "standalone", "voter", "backup", "regionPrimary", "primary" ]

  Member role

{
    "title":"Oracle GoldenGate Cluster Membership - Cluster Member Role",
    "description":"Details of the role that a cluster member plays",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:clusterRole"
            ]
        },
        "memberName":{
            "description":"The name of the cluster member",
            "type":"string",
            "pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
            "minLength":"1",
            "maxLength":"4095"
        },
        "current":{
            "description":"Member role",
            "type":"string",
            "enum":[
                "initialized",
                "standalone",
                "voter",
                "backup",
                "regionPrimary",
                "primary"
            ]
        },
        "target":{
            "description":"Member role",
            "type":"string",
            "enum":[
                "initialized",
                "standalone",
                "voter",
                "backup",
                "regionPrimary",
                "primary"
            ]
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"https://127.0.0.1:9011/services/v2/installation/cluster/role/oggdev-1",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"https://127.0.0.1:9011/services/v2/installation/cluster/role/oggdev-1",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"https://127.0.0.1:9011/services/v2/metadata-catalog/member",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:clusterRole",
        "memberName":"oggdev-1",
        "current":"primary"
    }
}

Back to Top