Volumes

Get Snapshot Status

Snapshot status for one (volume, edge) pair.

Reads directly from the DB. Returns HTTP 404 when no VolumeConnection exists for the pair (the mount is unknown to Portal — the repo raises :class:ResourceNotFound and the global exception handler maps it). Returns current_snapshot_status=idle when the mount is known but the filer has not yet reported any snapshot metrics for it.

get/volumes/{volume_id}/edges/{edge_id}/snapshots

Request

Path parameters

volume_idstring required
edge_idstring uuid required

Response

Current snapshot status for the given (volume_id, edge_id) pair

volume_idstring required
edge_idstring uuid required
current_snapshot_status'idle' | 'pending' | 'in_progress' | 'succeeded' | 'failed' | 'cancelling' | 'cancelled' | 'cancel_rejected' | 'up_to_date'

Public snapshot lifecycle vocabulary surfaced by the snapshot APIs.

The persisted column (VolumeEdgeState.current_snapshot_status) has a single writer: the EventHub VolumeSnapshotStatusProcessor, which translates filer volume_snapshot_status events. No other code path — API request handlers, heartbeat upserts, background services — writes to that column. cancelling never reaches the DB: it exists as a FE-optimistic wire value only (clients render it between the cancel dispatch and the filer's cancelled / cancel_rejected ack). pending is a real filer-reported state.

Changes

No recorded changes to this operation across all 1 revision of this API.