Show the status of an IBM IoT MessageSight server and services

Edit online

Purpose

Shows details about the status of the IBM® IoT MessageSight server, including information about High Availability (HA), cluster membership, the protocol plug-in server process, the MQ Connectivity process, and SNMP. If IBM IoT MessageSight is running in a Docker container, the information that is returned also includes the Docker container UUID.

URI

Use the IBM IoT MessageSight REST API GET method with the following IBM IoT MessageSight service URI:

http://<Server-IP:Port>/ima/v1/service/status/<ServiceName>

where:
ServiceName
Optional.
Specifies the service name.
You can specify only one service name.
If no service name is specified, status information for the server and all services is returned.
Valid service names are:
  • Server

    Returns status information about the IBM IoT MessageSight server.

  • Cluster

    Returns cluster status information.

  • HighAvailability

    Returns HA status information.

  • MQConnectivity

    Returns MQ Connectivity process status information.

  • Plugin

    Returns protocol plug-in server process status information.

  • SNMP

    Returns SNMP status information.

Usage Notes

  • Capitalization must be used as shown.

Example

The following example shows a GET method to display the status of the IBM IoT MessageSight server by using cURL: 

curl -X GET http://127.0.0.1:9089/ima/v1/service/status/Server
The following example shows an example response to the GET method that was used to display the status of the IBM IoT MessageSight server:

{
  "Version":"v1",
  "Server": {
    "Name": "TestSystem:9089",
    "UID": "aFWxYf32",
    "Status": "Running",
    "State": 1,
    "StateDescription": "Running (production)",
    "ServerTime": "2016-03-04T14:46:53.081Z",
    "UpTimeSeconds": 4134,
    "UpTimeDescription": "0 days 1 hours 8 minutes 54 seconds",
    "Version": "2.0 20160304-0400",
    "ErrorCode": 0,
    "ErrorMessage": ""
  },
  "Container": {
    "UUID":"034c91ce828a4f5c2c21d7cd7f04628368b63bd308825ec2d9dab5096ff04ca0"
  },
  "HighAvailability": {
    "Status": "Inactive",
    "Enabled": false
  },  
  "Cluster": {
    "Status": "Inactive",
    "Enabled": false
  },  
  "Plugin": {
    "Status": "Inactive",
    "Enabled": false
  },  
  "MQConnectivity": {
    "Status": "Active",
    "Enabled": true
  },  
  "SNMP": {
    "Status": "Inactive",
    "Enabled": false
  }
}

The following example shows a GET method to display the status of the IBM IoT MessageSight server only by using cURL: 

curl -X GET http://127.0.0.1:9089/ima/v1/service/status/Server

The following example shows an example response to the GET method that was used to display the status of the IBM IoT MessageSight server only:


{
  "Version":"v1",
  "Server": {
    "Name": "TestSystem:9089",
    "UID": "aFWxYf32",
    "Status": "Running",
    "State": 1,
    "StateDescription": "Running (production)",
    "ServerTime": "2016-03-04T14:46:53.081Z",
    "UpTimeSeconds": 4134,
    "UpTimeDescription": "0 days 1 hours 8 minutes 54 seconds",
    "Version": "2.0 20160304-0400",
    "ErrorCode": 0,
    "ErrorMessage": ""
  },
  "Container": {
    "UUID":"034c91ce828a4f5c2c21d7cd7f04628368b63bd308825ec2d9dab5096ff04ca0"
  }
}