Update Cluster Role
patch
/services/{version}/installation/cluster/role/{member}
Required Role: Security
Update a member's role in the OGG cluster
Request
Supported Media Types
- application/json
Path Parameters
-
member(required): string
Minimum Length:
1Maximum Length:4095Pattern:^(((([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" ]
Root Schema : Oracle GoldenGate Cluster Membership - Cluster Member Role
Type:
objectTitle:
Oracle GoldenGate Cluster Membership - Cluster Member RoleDetails 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:
1Maximum Length:4095Pattern:^(((([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
Example Request (application/json)
{
"target":"backup"
}Response
Supported Media Types
- application/json
201 Response
Installation added to cluster
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"rel":"canonical",
"href":"https://127.0.0.1:9011/services/v2/installation/cluster/role/oggdev-2",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"https://127.0.0.1:9011/services/v2/installation/cluster/role/oggdev-2",
"mediaType":"application/json"
}
],
"messages":[
{
"$schema":"ogg:message",
"title":"The role for cluster member 'oggdev-2' is transitioning to 'backup'.",
"code":"OGG-12339",
"severity":"INFO",
"issued":"2024-01-08T15:38:35Z",
"type":"https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes"
}
]
}