IRPCMonitoringStatus.GetActiveNotifications
Administration API / specialized admin session
Gets the active indexing notifications of the vault, such as "re-indexing required" or "rebuild in progress", combined over all indexes.
| Service | Monitoring status MFiles.IRPCMonitoringStatus |
|---|---|
| gRPC method | /MFiles.IRPCMonitoringStatus/GetActiveNotifications |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-active-notifications |
| Request | GetActiveNotificationsRequest |
| Response | GetActiveNotificationsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session with the vault right
see_all_objects. contextmust beMONITORING_CONTEXT_INDEXING; other values fail with "Not implemented.".
Request: GetActiveNotificationsRequest
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 |
|---|---|---|
context | MonitoringContext | Set MONITORING_CONTEXT_INDEXING.Values: MONITORING_CONTEXT_UNSPECIFIED (0), MONITORING_CONTEXT_INDEXING (1). |
Response: GetActiveNotificationsResponse
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 |
|---|---|---|
notifications | uint32 | The bits of INDEXNOTIFICATIONFLAGS as a number, ORed over all indexes: 1 re-index required (property definitions changed), 2 re-index required (language changed), 4 re-index required, 8 indexing in progress, 16 rebuild in progress, 32 active file data index required, 64 active metadata index required. 0 means no notifications. |