View the Status of Your API Gateway

You can view your API gateway system's status to determine if the system is configured and running.

Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.

Do the following to view the status of your API Gateway:

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:
  3. /opt/quantum/api-gateway/bin/apigw status

  4. Below is an example of the output:
  5. ocker stack quantum-api IS running.
    
    NAMES                                                                                STATUS
    quantum-api_kong-server.1.uusvafqd0ma57fe8yd6kynn33                                  Up 4 minutes (healthy)
    quantum-api_rest-aggregator-hseries-hosts.1.dtkdej44m5x9or98toan8zult                Up 4 minutes
    quantum-api_kong-database.1.il46uyawy18zfn2p0ki4xrdd8                                Up 4 minutes (healthy)
    quantum-api_keycloak-database.1.sjbzhogxftq4bs60hwylt7cpg                            Up 4 minutes (healthy)
    quantum-api_rest-aggregator-xwd-hosts.1.ywgrw8eotspxyty3wk6lgforx                    Up 4 minutes
    quantum-api_gateway-admin-api.1.q47k6tczu6smt6w8pq07awcw4                            Up 4 minutes
    quantum-api_rest-aggregator-fseries-hosts.1.xwlwi7em32qwqrwe5576niezh                Up 4 minutes
    quantum-api_rest-aggregator-metadata-controllers.1.udxngkgk8fjxkpss5b5mxoxvw         Up 4 minutes
    quantum-api_rest-aggregator-flexsync-hosts.1.e1ieaxgyxnkf7z0bfy1gomgsx               Up 4 minutes
    quantum-api_rest-aggregator-datamovers.1.64zrcrv5a10umz4nu3eqmcp7u                   Up 4 minutes
    quantum-api_rest-aggregator-name-servers.1.lidu2pi76peo21r5cigrlxs88                 Up 4 minutes
    quantum-api_rest-fs-create.1.l1wu4p81chc69eiy5f4e6rt66                               Up 4 minutes
    quantum-api_keycloak-server.1.w70nqooxuotp94p8ubt9184nh                              Up 4 minutes (healthy)
    quantum-api_rest-aggregator-pseries-hosts.1.87y0wum5556ygnbjz1wxymisj                Up 4 minutes
    quantum-api_rest-aggregator-appliance-controller-hosts.1.q0rgqxt4tf56m7q8ugqmd04u8   Up 4 minutes
    quantum-api_rest-templates.1.tpeb8gjf70fdfuu3hgrmppkjq                               Up 4 minutes
    quantum-api_endpoint-database.1.yxeel98ti5xhhr7t4bk2ghhjk                            Up 4 minutes (healthy)
    quantum-api_rest-aggregator-qxs-hosts.1.xv2arr9fwpohpa4y1ciw462xl                    Up 4 minutes
    quantum-api_rest-aggregator-filesystems.1.wfytktds77cyu5ecubckf3m2o                  Up 4 minutes
    quantum-api_rest-registrar.1.m7lrnrpj8x4ago1tljuha1g5t                               Up 4 minutes
    quantum-api_rest-aggregator-xwe-hosts.1.qfwczc17eebbfiqkkpe4imdjb                    Up 4 minutes
    quantum-api_user-management-api.1.4646xs0ip5jx8h44jnb0jbx82                          Up 4 minutes
    quantum-api_rest-aggregator-usbe-hosts.1.r2mfx6888u067enhsg5p99x6k                   Up 4 minutes
    quantum-api_license-aggregator.1.d70qib9uzmz0mqlhdgjphal3z                           Up 4 minutes
    quantum-api_license-sender.1.rtd7k6xvpgdpxyl2c53tmik6y                               Up 4 minutes
    quantum-api_rest-aggregator-hosts.1.w7wzgfaet0yyx29oillype80a                        Up 4 minutes