Promote Standby REST Service

Use Promote Standby REST Service to promote a standby master to primary master server. For example, if a primary master in the IBM Guardium Key Lifecycle Manager multi-master cluster fails, you might want to promote a standby master while you resolve the failure.

Operation: POST
URL: https://<host>:<port>/GKLM/rest/v1/ckms/config/nodes/takeoverAsPrimary

By default, IBM® Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or hostname of the IBM Guardium Key Lifecycle Manager server.
port	Specify the port number on which the IBM Guardium Key Lifecycle Manager server listens for requests.

Request Headers

Header name	Value
Content-Type	`application/json`
Accept	`application/json`
Authorization	`SKLMAuth userAuthId=<authIdValue>`
Accept-Language	Any valid locale that is supported by IBM Guardium Key Lifecycle Manager. For example, `en` or `de`.

Request body

JSON object with the following specification:

Property name	Description
clusterName	Specify the multi-master cluster to which the standby master server belongs to.
ipHostname	Specify the host name of the IBM Guardium Key Lifecycle Manager server server.

Response

Response Headers

Header name	Value and description
Status Code	200 OK The request was successful. The response body contains the requested representation. 400 Bad Request The authentication information was not provided in the correct format. 401 Unauthorized The authentication credentials were missing or incorrect. 404 Not Found Error The processing of the request fails. 500 Internal Server Error The processing of the request fails because of an unexpected condition on the server.
Content-Type	`application/json`
Content-Language	Locale for the response message.

Success response body

JSON object with the following specification:

JSON property name	Description
code	Returns the code that is specified by the `status` property.
status	Returns the status to indicate whether the standby is promoted to primary master.

Error Response Body

JSON object with the following specification.

JSON property name	Description
code	Returns the application error code.
message	Returns a message that describes the error.

Examples

Service request to promote a standby to primary master server

POST https://localhost:<port>/GKLM/rest/v1/ckms/config/nodes/takeoverAsPrimary
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
[
{"clusterName":"multimaster"},
{"ipHostname": "civ3cez160"}
]

Success response

Status Code: 200 OK
{"code":"0","status":"CTGKM2993I Successfully promoted standby to primary."}

Error response

{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}