Use Regenerate Cluster Name REST Service to regenerate the name of the
Multi-Master cluster. You can run this REST service on any master server. When the primary master
server is no longer a part of the cluster, then you can use this REST service to provide a new name
to the cluster. The new name is based on the new primary master server. The REST service returns the
name of the cluster if a primary master server is no longer in the primary role of a cluster but a
part of the cluster.
- Operation
POST- URL
- https://host:port/GKLM/rest/v1/ckms/config/nodes/regenerateClusterName
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 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. |
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 |
| clusterName |
New or regenerated name of the cluster. The cluster name is generated by using
the host name of the primary master server. For example,
primary_hostname-cluster. A cluster gets its name when it
is created, and is based on the then configured primary master server. Only when this primary master
server is not a part of the cluster and you run this REST service, a new cluster name is generated.
If the primary master server is no longer in the primary role but still a part of the cluster, the
existing cluster name is returned. |
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. |
Example
- Service request to regenerate cluster name
-
POST https://localhost:port/GKLM/rest/v1/ckms/config/nodes/regenerateClusterName
- Success response
-
Status Code : 200 OK
Content-Language: en
{
"clusterName": "isklm.aa.xyz.com-cluster"
}
- Error response
-
Status Code: 400 Bad Request
Content-Language: en
{"code": "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}