GearN Server | Rest Api references | Health Check

Overview

Check server instance health and primary-instance status.

Client

No require permission rules.

HTTP

GET /healthcheck

Response Body

200 Ok

Code	Type	Required	Description
error	string		Error message returned when the health check cannot be completed.
data	HealthCheckDataResponse		Health information for the current server instance and peer instances. See HealthCheckDataResponse

HealthCheckDataResponse

Code	Type	Required	Description
thisInstance	InstanceResponse	true	Health details for the server instance that handled this request. See InstanceResponse
otherInstances	OtherInstanceResponse[]	true	Health details for the other known server instances. See OtherInstanceResponse

InstanceResponse

Code	Type	Required	Description
instanceId	string	true	Unique identifier of the server instance.
isPrimary	boolean	true	Whether this instance is currently the primary instance.
currentInstanceIdPrimary	string	true	Instance id currently recognized as primary.
currentTsPrimary	number	true	Current primary timestamp in milliseconds.
currentTsPrimaryToDate	string	true	Current primary timestamp formatted as a date string.
tsPrimary	number	true	Last known primary timestamp in milliseconds.
tsPrimaryToDate	string	true	Last known primary timestamp formatted as a date string.

OtherInstanceResponse

Code	Type	Required	Description
instanceId	string	true	Unique identifier of the server instance.
isPrimary	boolean	true	Whether this instance is currently the primary instance.
currentInstanceIdPrimary	string	true	Instance id currently recognized as primary.
currentTsPrimary	number	true	Current primary timestamp in milliseconds.
currentTsPrimaryToDate	string	true	Current primary timestamp formatted as a date string.
tsPrimary	number	true	Last known primary timestamp in milliseconds.
tsPrimaryToDate	string	true	Last known primary timestamp formatted as a date string.
lostPing	number	true	Number of missed ping checks for this instance.