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 (
You have to the setup the Route for the status API and expose it using the public-api Plugin.
curl http://127.0.0.1:9080/apisix/admin/routes/ns -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Once you have configured the Plugin, you can make a request to the
apisix/status endpoint to get the status:
curl http://127.0.0.1:9080/apisix/status -i
HTTP/1.1 200 OK
Date: Tue, 03 Nov 2020 11:12:55 GMT
Content-Type: text/plain; charset=utf-8
Server: APISIX web server
The parameters in the response are described below:
|status||Status of APISIX.|
|total||Total number of client requests.|
|waiting||Number of idle client connections waiting for a request.|
|accepted||Number of accepted client connections.|
|writing||Number of connections to which APISIX is writing back a response.|
|handled||Number of handled connections. Generally, this value is the same as |
|active||Number of active client connections including |
|reading||Number of connections where APISIX is reading the request header.|
|id||UID of APISIX instance saved in |
To remove the Plugin, you can remove it from your configuration file (
You can also remove the Route on
curl http://127.0.0.1:9080/apisix/admin/routes/ns -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X DELETE