Viewing high availability configuration details by using a REST Administration API

Edit online

System administrators can view configuration details of the high availability (HA) service by using the IBM® IoT MessageSight REST API GET method.

About this task

You can view HA configuration details by using a REST Administration API, or by using the IBM IoT MessageSight Web UI. For more information about using the IBM IoT MessageSight Web UI to view HA configuration details, see Configuring IBM IoT MessageSight servers as an HA pair by using the IBM IoT MessageSight Web UI.

Procedure

To view HA configuration details, use the IBM IoT MessageSight REST API GET method with the following IBM IoT MessageSight URI:

Note: The command must be capitalized as shown.

http://<admin-endpoint-IP:Port>/ima/v1/configuration/HighAvailability

Example

The following example shows a GET method to display the HA configuration details of an IBM IoT MessageSight server by using cURL:

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/HighAvailability

The following example shows a successful example response to the GET method that was used to display HA configuration details:

{   
  "Version": "v1",
  "HighAvailability": {
    "EnableHA": true,
    "Group": "Group2",
    "StartupMode": "AutoDetect",
    "PreferredPrimary": true,
    "DiscoveryTimeout": 600,
    "HeartbeatTimeout": 10,
    "RemoteDiscoveryNIC": "10.11.1.212",
    "LocalReplicationNIC": "10.12.1.87",
    "LocalDiscoveryNIC": "10.11.1.87",
    "ExternalReplicationNIC": "10.11.1.210",
    "ExternalReplicationPort": 1024,
    "ReplicationPort": 1025,
    "RemoteDiscoveryPort": 1026,
    "UseSecuredConnections": false
   } 
}