Get All Masters Status REST Service

Use Get All Masters Status REST Service to obtain status information that indicates whether all the communication ports in the master servers are reachable.

Operation
GET
URL
https://<host>:<port>/SKLM/rest/v1/ckms/nodes/allNodeStatus

By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security 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 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
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 array that contains JSON objects with the following specification:

JSON property name Description
nodeType Returns the master type, such as PRIMARY, STANDBY, or LOCAL.
nodeIP Returns the IP address of the master.
ippPortStatus Returns the status code that indicates whether the IBM Proprietary Protocol (IPP) port is reachable.
kmipPortStatus Returns the status code that indicates whether the Key Management Interoperability Protocol (KMIP) port is reachable.
agentPortStatus Returns the status code that indicates whether the agent port in the master is reachable.
sslPortStatus Returns the status code that indicates whether the TLS port is reachable.
adminPortStatus Returns the status code that indicates whether the WebSphere® Application Server Liberty port for the IBM Security Guardium Key Lifecycle Manager profile is reachable.
dbPortStatus Returns the status code that indicates whether the DB2® service listening port is reachable.
httpPortStatus Returns the status code that indicates whether the HTTPS port is reachable.
actingPrimary Returns whether the master is promoted as a primary master.
lastUpdateTimeStamp Returns the time stamp that the master status was last updated.
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 get status of all the masters in the cluster
GET https://localhost:<port>/SKLM/rest/v1/ckms/nodes/allNodeStatus
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
Success response
Status Code : 200 OK
Content-Language: en
[
 {
   "nodeType":"STANDBY",
   "nodeIP":"cimkc2a177",
   "ippPortStatus":0,
   "kmipPortStatus":0,
   "agentPortStatus":0,
   "sslPortStatus":0,
   "adminPortStatus":0,
   "dbPortStatus":0,
   "httpPortStatus":0,
   "actingPrimary":false,
   "lastUpdateTimeStamp":"2017-07-21 13:32:40.536"
 },
 {
   "nodeType":"PRIMARY",
   "nodeIP":"cimkc2a176",
   "ippPortStatus":0,
   "kmipPortStatus":0,
   "agentPortStatus":0,
   "sslPortStatus":0,
   "adminPortStatus":0,
   "dbPortStatus":0,
   "httpPortStatus":0,
   "actingPrimary":true,
   "lastUpdateTimeStamp":"2017-07-21 13:06:36.752"
 }
]
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid 
user authentication ID or invalid request format."}