IRPCTest.TestConnectionToVault
Vault API / standard write session idempotent
Checks that the session is a valid vault session, and does nothing else.
| Service | Connection and health checks MFiles.IRPCTest |
|---|---|
| gRPC method | /MFiles.IRPCTest/TestConnectionToVault |
| HTTP (mf-http-grpc) | POST /grpc/v1/test-connection-to-vault |
| Request | TestConnectionToVaultRequest |
| Response | TestConnectionToVaultResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Send the session in mfiles-session-id-bin. The call succeeds with an empty response while the
session is valid. A missing, unknown or logged-out session fails with UNAUTHENTICATED.
A server-level session (opened with the all-zero vault GUID) fails with E_MFILES_LOGIN_REQUIRED
("Login required.").
This is the cheapest way to find out whether a session is still usable before a batch of work, and to measure the round-trip time of authenticated vault calls. It does not reset the session's idle timer: keep the session open with KeepAlive.
Request: TestConnectionToVaultRequest
No fields.
Response: TestConnectionToVaultResponse
No fields.
Related methods
- IRPCLogin.KeepAlive -- Tells the server that the session is still in use, so that it does not expire.