Skip to main content
Version: Next



The node-status Plugin can be used get the status of requests to APISIX by exposing an API endpoint.




This Plugin will add the endpoint /apisix/status to expose the status of APISIX.

You may need to use the public-api Plugin to expose the endpoint.

Enabling the Plugin#

To configure the node-status Plugin, you have to first enable it in your configuration file (conf/config.yaml):

plugins:  - example-plugin  - limit-req  - jwt-auth  - zipkin  - node-status  ......

You have to the setup the Route for the status API and expose it using the public-api Plugin.

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/apisix/status",    "plugins": {        "public-api": {}    }}'

Example usage#

Once you have configured the Plugin, you can make a request to the apisix/status endpoint to get the status:

curl localhost:9080/apisix/status -i
HTTP/1.1 200 OKDate: Tue, 03 Nov 2020 11:12:55 GMTContent-Type: text/plain; charset=utf-8Transfer-Encoding: chunkedConnection: keep-aliveServer: APISIX web server

The parameters in the response are described below:

statusStatus of APISIX.
totalTotal number of client requests.
waitingNumber of idle client connections waiting for a request.
acceptedNumber of accepted client connections.
writingNumber of connections to which APISIX is writing back a response.
handledNumber of handled connections. Generally, this value is the same as accepted unless any a resource limit is reached.
activeNumber of active client connections including waiting connections.
readingNumber of connections where APISIX is reading the request header.
idUID of APISIX instance saved in apisix/conf/apisix.uid.

Disable Plugin#

To remove the Plugin, you can remove it from your configuration file (conf/config.yaml):

plugins:  - example-plugin  - limit-req  - jwt-auth  - zipkin  ......

To disable the node-status Plugin on a Route, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/route1",    "upstream": {        "type": "roundrobin",        "nodes": {            "": 1        }    },    "plugins": {}}'

You can also remove the Route on /apisix/status:

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X DELETE