Service Health Status
The purpose of the Get Service Health Status is to provide a feedback loop on the current health of the Data Adapter.
Data Adapter APIβ
Get Service Health Statusβ
Loading...
Endpoint Specific Guidanceβ
- Each HaaS service that connects to the data adapter will poll the Get Health endpoint once per minute (resulting in ~4-5 polls/min).
- If the
"Status" = "DOWN", Biza will suspend all data adapter calls and return the appropriate error code to the ADR. When"Status" = "UP"is returned, Biza will resume parsing on the data adapter calls. - Relevant metrics will be logged and reported accordingly when
"Status" = "DOWN". - The parameters determining when the Data Holder should report
"Status" = "UP"or"Status" = "DOWN"is at the Data Holder's discretion, and as such, Biza does not provide specific guidance on this. However, we do suggest that at a minimum these statuses reflect instances where the Data Holder's infrastructure experiences failures.