IRPCTest.CheckServerHealthAnonymous
Vault API / standard read no session idempotent
Succeeds when the server and all its vaults have finished starting; fails otherwise. No session needed.
| Service | Connection and health checks MFiles.IRPCTest |
|---|---|
| gRPC method | /MFiles.IRPCTest/CheckServerHealthAnonymous |
| HTTP (mf-http-grpc) | POST /grpc/v1/check-server-health-anonymous |
| Request | CheckServerHealthAnonymousRequest |
| Response | CheckServerHealthAnonymousResponse |
| Book and level | Vault API, standard |
| Kind | read |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Needs no session. The call succeeds with an empty response when all of these hold:
- Every vault has finished going online.
- Every vault that is set to be online is online.
- On servers that load their vaults from One DB, the latest refresh from One DB succeeded.
Otherwise it fails with E_FAIL and no details. Use it as a readiness probe for the whole server,
for example after a restart. To see which check fails, call
GetServerHealth with a session; to probe one vault, use
CheckVaultHealthAnonymous.
Request: CheckServerHealthAnonymousRequest
No fields.
Response: CheckServerHealthAnonymousResponse
No fields.
Related methods
- GetServerHealth -- Runs the server health checks you select and returns the result of each.
- CheckVaultHealthAnonymous -- Succeeds when a vault on this server is ready for use; fails otherwise. No session needed. Made for load balancer health probes.