Amazon Neptune
User Guide (API Version 2017-11-29)

Check the Health Status of a Neptune Instance

Amazon Neptune provides a mechanism to check the status of the graph database on the host. It's also a good way to confirm that you are able to connect to an instance.

To check the health of an instance using curl:

curl -G https://your-neptune-endpoint:port/status

If the instance is healthy, the status command returns four fields:

  • status   –   As long as the instance is not experiencing problems, this field is set to "healthy".

    If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, the status is set to "recovery".

  • version   –   This field is set to the Neptune engine version.

    If this engine version has been manually patched since it was released, the version number is prefixed by "Patch-".

  • startTime   –   This field is set to the UTC time at which the current server process started.

  • role   –   This field is set to "reader" if the instance is a read-replica or to "writer" if the instance is the primary instance.

The following is an example:

{ "status": "healthy", "version": "", "startTime": "04-15-2019 10:00:00 UTC", "role": "reader" }

If there is a problem with the instance, the status command returns the HTTP 500 error code. If the host is unreachable, the request times out. Ensure that you are accessing the instance from within the virtual private cloud (VPC), and that your security groups allow you access to it.