IRPCTest.CheckVaultHealthAnonymous
Vault API / standard read no session idempotent
Succeeds when a vault on this server is ready for use; fails otherwise. No session needed. Made for load balancer health probes.
| Service | Connection and health checks MFiles.IRPCTest |
|---|---|
| gRPC method | /MFiles.IRPCTest/CheckVaultHealthAnonymous |
| HTTP (mf-http-grpc) | POST /grpc/v1/check-vault-health-anonymous |
| Request | CheckVaultHealthAnonymousRequest |
| Response | CheckVaultHealthAnonymousResponse |
| 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 the vault is fully online, its database can be read and its file data storage can be accessed. A load balancer in front of several servers that host the same vault can call it on each server and route traffic only to the servers that answer successfully.
Any failed check, including a vault that is offline or still starting, fails with
E_MFILES_VAULT_CANT_BE_USED_RIGHT_NOW ("The vault can't be used right now.") without further
details. An unknown vault GUID, an empty string and the all-zero GUID fail with
E_MFILES_UNKNOWN_VAULT ("The specified document vault does not exist."); a malformed GUID fails
with E_INVALIDARG ("The parameter is incorrect.").
Compared with TestVaultAvailability, this method always treats a vault that is not ready as a failure and never reveals why it failed.
Request: CheckVaultHealthAnonymousRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
guid | string | The vault GUID, with or without braces, in any case. |
Response: CheckVaultHealthAnonymousResponse
No fields.
Related methods
- TestVaultAvailability -- Checks that a vault on this server is online and that its database and file data storage can be accessed. No session needed.