This documentation is for WSO2 Microgateway 3.0.1. View documentation for the latest release.

All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

When errors/exceptions occur in the system, the API Microgateway throws error responses to the client by default. The following sections explain about the different ways of troubleshooting common problems that might occur while you use the Microgateway.

Common exceptions and solutions

The table below shows the common exceptions that might occur when you are trying to use the API Microgateway, and how to fix them. These exceptions can happen due to misconfigurations.

Error logPossible causeResolution
micro-gw: Error occurred while trying to connect with server. Is the server running at https://localhost:9443?

The API Manager node (Publisher) is down when running the setup command in the Microgateway.

Verify the connectivity between the Microgateway and the API manager node.
micro-gw: Error in client response : {message:"Network is unreachable:", cause:null}

A connection to the backend could not be established because the network is unavailable.

Verify the network stability.
Micro-gw: ERROR [src:0.0.0] - Error in client response : {message:"Connection refused: localhost/", cause:null}Connection to the backend is refused.Check the connection to the backend.
error [docker plugin]: Unable to build docker image: {"message":"invalid reference format: repository name must be lowercase"}

The name of the docker images should be in lower case.

When building the project with docker annotations, the docker image name is retrieved from the API name and version. If the API name contains a capital letter, then the docker image n ame would reflect that, resuling in this error.

When building the API microgateway project, provide a simple letter name for the docker image in the deployment.toml file as shown below.

    enable = true
    name = "hello_world"

ERROR [wso2/gateway:0.0.0] - Error occurred while reading the key validation response : {message:"Connection refused: localhost/", cause:null}
ERROR [wso2/gateway:0.0.0] - Error occurred while converting the authorized value from the key validation response to a
string value : {message:"'null' cannot be cast to 'string'", cause:null}

ERROR [wso2/gateway:0.0.0] - Error occurred while getting key validation information for the access token : {message:"call failed", cause:{message:"call failed", cause:{message:"'null' cannot be cast to 'string'", cause:null}, causes:[{message:"'null' cannot be cast to 'string'", cause:null}]}, causes:[{message:"call failed", cause:{message:"'null' cannot be cast to 'string'", cause:null}, causes:[{message:"'null' cannot be cast to 'string'", cause:null}]}]}

The Microgateway could not connect to the Key Manager for OAuth2 key validation.Check the connection between the Microgateway and the Key Manager.
ERROR [wso2/gateway:0.0.0] - Error occurred while reading the key validation response : {message:"General SSLEngine problem/", cause:null}
ERROR [wso2/gateway:0.0.0] - Error occurred while converting the authorized value from the key validation response to a
string value : {message:"'null' cannot be cast to 'string'", cause:null}
SSL hostname verification has failed in the key validation call.
The localhost hostname is supported by default.
You need to add the public certificate of the Key Manager to the Microgateway truststore. Also, make sure that you change the certificateAlias accordingly.
ERROR [ballerina/http] - Error while validating JWT token : {message:"Invalid signature", cause:null}JWT signature verification has failed.
Verify the following:
  • JWT signer’s public cert should be available in the Microgateway’s truststore.
  • The correct Certificate Alias should be given in the <MGW_HOME>/conf/micro-gw.conf file.
ERROR {org.wso2.apimgt.gateway.cli.cmd.Main} - Internal error occurred while executing command.
com.github.jknack.handlebars.HandlebarsException: /home/pubudu/Downloads/wso2am-micro-gw-toolkit-2.5.0/resources/templates/service.mustache:36:87: java.lang.IllegalStateException: Can't resolve: 'doc'
This is due to an issue in the Service template.
  • Open the <MGW_HOME>/resources/templates file.
  • Remove the @swagger:ServiceInfo annotation-related configuration in the service.mustache template.
  • Re-run the setup command.
micro-gw: Project name `petstore` already exist. You get this error when you re-run the  micro-gw init <project-name>  command while you already have a project with the same name (e.g.,   petstore ) in the current working directory.

Carry out one of the following actions to overcome this error.

  • Override the current project
    If you need to override the current Microgateway project, run the init command with the -f (--force)option. For example, use the following command if you are overriding the petstore project.

    micro-gw init <project-name> -f
  • Create a new project

    If you do not need to override the current Microgateway project, run the init command with another project name from another working directory.

    micro-gw init <project-name>

Error responses

Error codeError responsePossible reasons
    "fault": {
        "code": "101503",
        "message": "Runtime Error",
        "description": "Error connecting to the back end"
  • The network is not reachable by the backend.
  • The connection from the backend has been refused.
    "fault": {
        "code": "101504",
        "message": "Runtime Error",
        "description": "Connection timed out"
  • The connection has timed out.
  • The connection has timed out from the Microgateway end.
  • Response is getting delayed and hence timeout occurs in the Microgateway side.
    "fault": {
        "code": 900900,
        "message": "Unclassified Authentication Failure",
        "description": "Unclassified Authentication Failure"
  • The Key Manager is down.

Error codes

Given below are some API Manager-specific error codes and their meanings. For more details on error codes and their descriptions, see Error Handling.

Error codePossible reason
900901The production/sandbox key offered by the requested endpoint is not specified.
900900API-M authentication related error.
900901Invalid access token.
900902Missing credentials.
900903Access token expired.
900904Access token inactive.
900905Incorrect access token type provided.
900906No matching resource found in the API for the given request.
900907The requested API is temporarily blocked.
900908Resource forbidden.
900909The subscription to the API is inactive.
900910The access token does not allow you to access the requested resource.
900803Application level throttled out.
900804Subscription level throttled out.
900808An internal error occurred in the Microgateway.
900809An internal error occurred in the Microgateway, since a subscription or application throttle policy is not deployed. This might be due to adding a throttle policy to API-M and not regenerating the Microgateway.
  • No labels