Check Service Availability

This topic describes how you can assess the availability of the CA API Gateway service. This allows you to confirm that the actual service is running, not just whether the processing node is alive on the network. To check for service availability, configure ports 8080 and 8443 with the following parameters:
  • Set the frequency of checking setting to 
    120
     seconds. 
    Tip:
     A lower value provides faster failure detection, but may cause excessive load on the Gateway cluster.
  • Set the response timeout to 
    120
     seconds
  • For port 8080, set the communication type to 
    Normal
  • For port 8443, set the communication type to 
    SSL
  • Configure ports 8080 and 8443 to check the URI "
    /ssg/ping
    ". By default, the "/ssg/ping" URI responds only when the request is submitted using SSL on port 8443, with HTTP basic credentials in the request. To enable non-SSL response without credentials, adjust the 
    pingServlet.mode
     cluster property
    Do not use the "/ssg/ping" URI to do a node health check during a load balancer availability check. Doing so impacts the performance of the cluster significantly. For an alternative, see "Load Balancer Health Check" in Configuring the Load Balancer.
An "OK" message is displayed when the Gateway connects successfully to the cluster storage, confirming that the service is working. If the connection fails, the message 
"The server is not in an operational state"
 appears after about 20 seconds.