Viewing the status of the MQ Connectivity process by using a REST Administration API

System administrators can view the status of the MQ Connectivity process by using the IBM® Watson IoT Platform - Message Gateway REST API GET method.

About this task

You can view the MQ Connectivity process status by using REST Administration APIs, or by using the IBM Watson IoT Platform - Message Gateway Web UI. For more information about using the IBM Watson IoT Platform - Message Gateway Web UI to view the MQ Connectivity process status, see Restarting, stopping, and viewing the status of MQ Connectivity by using the IBM Watson IoT Platform - Message Gateway Web UI.

Procedure

To view the status of the MQ Connectivity process, use the IBM Watson IoT Platform - Message Gateway REST API GET method with the following IBM Watson IoT Platform - Message Gateway configuration URI:

http://<admin-endpoint-IP:Port>/ima/v1/service/status/MQConnectivity

Note: The status of the MQ Connectivity is also returned as part of the data that is returned from the IBM Watson IoT Platform - Message Gateway REST API GET method with the following URI:

http://<admin-endpoint-IP:Port>/ima/v1/service/status

Results

The following MQ Connectivity process status information is returned:
Status
The status of the MQ Connectivity process. Possible values, and their meanings, are:
Active
The MQ Connectivity process is running.
Inactive
The MQ Connectivity process is not running.
Enabled
Whether the MQ Connectivityprocess is enabled. You can enable and disable the MQ Connectivity process by setting the MQConnectivityEnabled configuration object. For more information, see Starting, restarting and stopping the MQ Connectivity process by using REST Administration APIs. Possible values, and their meanings, are:
true
The MQ Connectivity process is enabled.
false
The MQ Connectivity process is not enabled.

Example

The following example demonstrates displaying the MQ Connectivity process by using cURL. 

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

The following example shows an example response to the GET method:


{    
  "Version":"v1",    
    "MQConnectivity": {
     "Status": "Active",     
     "Enabled": true    
    } 
}