IRPCServerAdmin.BeginPerformanceMeasurementsAsJSON
Administration API / specialized admin session idempotent
Starts a database performance measurement in the session's vault and returns its ID.
| Service | Server administration MFiles.IRPCServerAdmin |
|---|---|
| gRPC method | /MFiles.IRPCServerAdmin/BeginPerformanceMeasurementsAsJSON |
| HTTP (mf-http-grpc) | POST /grpc/v1/begin-performance-measurements-as-json |
| Request | BeginPerformanceMeasurementsAsJSONRequest |
| Response | BeginPerformanceMeasurementsAsJSONResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| 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
- Starts a background operation and returns when it has started; poll the results with GetPerformanceMeasurementsAsJSON and stop it with EndPerformanceMeasurementsAsJSON.
- Requires a vault session with the vault right
change_full_control_role(vault administrators have it). A server-level session fails with "Login required.". - The measurement belongs to the session: starting a new one removes any earlier measurement of the same session.
Request: BeginPerformanceMeasurementsAsJSONRequest
No fields.
Response: BeginPerformanceMeasurementsAsJSONResponse
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 |
|---|---|---|
background_op_id | int32 | The ID of the measurement, for the Get and End calls. |
Related methods
- GetPerformanceMeasurementsAsJSON -- Gets the current results of a vault database performance measurement as JSON.
- EndPerformanceMeasurementsAsJSON -- Stops and removes a performance measurement started with BeginPerformanceMeasurementsAsJSON.