Troubleshooting the Micro Gateway

Troubleshooting topics for the Micro Gateway.

Important: IBM® API Connect Micro Gateway is deprecated in IBM API Connect Version 5.0.8 in favor of DataPower® Gateway. From 1 April 2020, Micro Gateway, and associated toolkit CLI commands, will no longer be supported. Existing users can migrate their API definitions to IBM DataPower Gateways. For information on supported API policies, see Built-in policies.

Specifying HTTP as scheme in an API might result in the API running on HTTPS.

You create an API in API Manager, add a path, and set an invoke policy target URL. Specify HTTP in the Schemes section of the Design tab. The OpenAPI (Swagger 2.0) document shows:


schemes:
  - http

Click Run > Start and you get an error, and the Micro Gateway does not start.

Solution

The Micro Gateway does not support both HTTP and HTTPS simultaneously. If on start, the Micro Gateway detects any OpenAPI (Swagger 2.0) document with HTTPS enabled, HTTPS is used for all APIs.

For a single instance of the Micro Gateway, all APIs must use either HTTP or HTTPS. Do not mix APIs that use HTTP with APIs that use HTTPS on the same Micro Gateway instance.

Authentication request timed out.

Basic Authentication to an HTTP server might return an error before the configured timeout. The Micro Gateway response to a client whose request cannot be completed due to the server authentication request timing out does not indicate that the cause is a timeout. You might receive an error similar to the following message:

Status Code
401:Error: Unauthorized.

Solution: The default timeout values for LDAP and Basic Authentication are not the same. The LDAP timeout is 60 seconds, and the Basic Authentication timeout is 120 seconds.

Unsupported Node.js versions might cause segmentation faults.: If unsupported Node.js versions are used, the Micro Gateway might fail with segmentation faults.

Solution: Ensure that a supported version of Node.js is installed. In particular, do not run Node.js version 5.9.0, which causes a known segmentation fault in the contextify code.
Check for the most recent software requirements for IBM API Connect Version 5.0. For more information, see the Software requirements section of the IBM API Connect Version 5.0 requirements.

How to replace an existing Micro Gateway with an updated version.: When you attempt to republish a Micro Gateway, instead of replacing the existing one, a second Micro Gateway is created.

Solution: To update the component, you must remove the old Micro Gateway, and republish it. For instructions, see Removing an application from a collective.