Get Single Master Details REST Service

Use Get Single Master Details REST Service to retrieve configuration details of a specific master in the IBM Security Key Lifecycle Manager multi-master cluster.

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

By default, IBM Security Key Lifecycle Manager server listens to non-secure port 80 (HTTP) and secure port 443 (HTTPS) for communication. During IBM Security Key Lifecycle Manager installation, you can modify these default ports. If you are using the default port for HTTP or HTTPS, the port is an optional part of the URL.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or host name of the IBM Security Key Lifecycle Manager server.
port	Specify the port number on which the IBM Security 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 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. 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
instanceId	Returns the unique ID that identifies the master in the cluster.
name	Returns the name of the master in the cluster.
clusterName	Returns the name for the cluster to which the master belongs.
ipHostname	Returns the IP address or host name of the IBM Security Key Lifecycle Manager server.
tcpPort	Returns the port number on which the IBM Security Key Lifecycle Manager server listens for requests from devices.
httpPort	Returns the default HTTPS port to access IBM Security Key Lifecycle Manager graphical user interface and REST services.
adminPort	Returns the WebSphere® Application Server port for the IBM Security Key Lifecycle Manager profile.
sslPort	Returns the port number on which the IBM Security Key Lifecycle Manager server listens for requests from devices that communicate by using the SSL protocol.
kmipPort	Returns the port number on which the IBM Security Key Lifecycle Manager server listens for requests from devices that communicate over the SSL socket by using the Key Management Interoperability Protocol.
dbPort	Returns the DB2 service listening port.
hadrPort	Returns the HADR port for the database.
agentPort	Returns the port number on which the agent listens for requests.
hadrType	Returns the HADR database type. 0 Local 1 Primary 2 Standby 3 Node
instanceType	Returns the IBM Security Key Lifecycle Manager instance type. 0 Standalone 1 Replication 2 Multi-master
status
dbName	Returns the name of the IBM Security Key Lifecycle Manager database.
dbUsername	Returns the user ID of the IBM Security Key Lifecycle Manager database administrator.
dbPassword	Returns the password for the database administrator user ID.
sklmUsername	Returns the name of the IBM Security Key Lifecycle Manager administrator.
sklmPassword	Returns the password for the IBM Security Key Lifecycle Manager administrator.
wasUsername	Returns the WebSphere Application Server login user ID for the IBM Security Key Lifecycle Manager administrator profile.
wasPassword	Returns the password for the WebSphere Application Server login user ID.
actingPrimary	Indicates whether the IBM Security Key Lifecycle Manager master in the cluster is now the primary server.
isFaulty	Indicates whether any error with the database of IBM Security Key Lifecycle Manager master.
isServerRestartRequired	Indicates whether the IBM Security Key Lifecycle Manager master needs to be restarted to accept the configuration changes, if any.
agentKeystorePassword	Returns the agent keystore password.
standbyPriorityIndex	Returns the priority index value for the standby database to takeover when the primary database is down.
lastUpdateTimestamp	Returns the last update timestamp.

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 retrieve configuration details of a specific master in the cluster

GET https://localhost:<port>/SKLM/rest/v1/ckms/nodes/getThisNodeDetails
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Success response

Status Code : 200 OK
Content-Language: en
{"instanceId": "a1eff98",
 "name": "a1eff98",
 "clusterName": "multimaster",
 "ipHostname": "cimkc2b207.in.ibm.com",
 "tcpPort": "3801",
 "httpPort": "443",
 "adminPort": "9083",
 "sslPort": "441",
 "kmipPort": "5696",
 "dbPort": "50050",
 "hadrPort": "0",
 "agentPort": "60015",
 "hadrType": "0",
 "instanceType": "0",
 "status": "0",
 "dbName": "SKLMDB31",
 "dbUsername": "sklmdb31",
 "dbPassword": "02C1F7918BB1B67E30DA1C7D045BF61E",
 "sklmUsername": "SKLMAdmin",
 "sklmPassword": "9E90A856ABDABA9ED0CD795C71630A7C",
 "wasUsername": "wasadmin",
 "wasPassword": "DEC98DF1096BFF2CDE234FDCB6BC8356",
 "actingPrimary": "0",
 "isFaulty": "0",
 "isServerRestartRequired": "0",
 "agentKeystorePassword": "7B2F9ABCCF56299F047E60981982348B",
 "standbyPriorityIndex": "0",
 "lastUpdateTimestamp": "6/30/17, 10:17:37 AM India Standard Time"}

Error response

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