IRPCTest.TestVaultAvailability
Vault API / standard write no session
Checks that a vault on this server is online and that its database and file data storage can be accessed. No session needed.
| Service | Connection and health checks MFiles.IRPCTest |
|---|---|
| gRPC method | /MFiles.IRPCTest/TestVaultAvailability |
| HTTP (mf-http-grpc) | POST /grpc/v1/test-vault-availability |
| Request | TestVaultAvailabilityRequest |
| Response | TestVaultAvailabilityResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Needs no session; an mfiles-session-id-bin header, if sent, is ignored. The call succeeds with an
empty response when the vault passes the checks.
When the vault is fully online, the server checks that the vault database and the vault's file
data storage can be accessed. A failed check returns the error code of the failure, with any
details replaced by ********.
When the vault is not fully online, or the server is shutting down, the result depends on
check_online_status:
false: the call succeeds without checking anything. Use this when an offline vault is not an error for you.true: the call fails withE_MFILES_SHUTDOWN_IN_PROGRESS,E_MFILES_VAULT_OFFLINE,E_MFILES_VAULT_GOING_OFFLINEorE_MFILES_VAULT_NOT_READY(the vault is still starting). The exception is a vault taken offline by its scheduled optimization job: the call succeeds.
An unknown vault GUID fails with E_MFILES_UNKNOWN_VAULT ("The specified document vault does not
exist.", with the detail Vault ID: <guid>) whatever check_online_status is. An empty string
counts as the all-zero GUID and fails the same way; a malformed GUID fails with E_INVALIDARG
("The parameter is incorrect.").
For a load balancer probe, prefer CheckVaultHealthAnonymous, which is made for that purpose.
Request: TestVaultAvailabilityRequest
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 |
|---|---|---|
vault | string | The vault GUID, with or without braces, in any case. |
check_online_status | bool | true to fail when the vault is not fully online; false to succeed without checks in that case. |
Response: TestVaultAvailabilityResponse
No fields.
Related methods
- CheckVaultHealthAnonymous -- Succeeds when a vault on this server is ready for use; fails otherwise. No session needed. Made for load balancer health probes.