Join Back Cluster REST Service
Use Join Back Cluster REST Service to rejoin an isolated master server, which is configured in read-write mode, to a Multi-Master cluster. If you detect conflicts when rejoining the master server, first resolve the conflicts, and then run the REST service again to rejoin the master server to the cluster. For more information, see Conflict resolution REST Services.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/ckms/config/nodes/joinBackTheCluster
By default, Guardium Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443
(HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager
installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable
when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized
environment.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or host name of the IBM Security Guardium Key Lifecycle Manager server. |
port | Specify the port number on which the IBM Security 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 Security Guardium Key Lifecycle Manager. For example: en or de |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 isolated read-write master is joined back the multi-master cluster. |
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 rejoin isolated read-write master back to the multi-master cluster
GET https://localhost:<port>/SKLM/rest/v1/ckms/config/nodes/joinBackTheCluster Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en
- Success response
Status Code : 200 OK Content-Language: en { "code":"0", "status":"CTGKM3220I Join back to cluster process is successful." }
- Error response
Status Code: 400 Bad Request Content-Language: en {"code": "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}