File Storage Service - Managing Share Snapshots

Objective

Snapshots capture a point-in-time state of a File Storage NFS share. This guide shows how to list, create, and delete snapshots using the OVHcloud API (v1 /cloud routes), ensuring consistency and operational reliability.

Requirements

• A Public Cloud project with File Storage Service enabled.
• An existing share in available state.
• API credentials with sufficient permissions to manage shares and snapshots.
• Understanding of key API concepts: serviceName (project ID), regionName, shareId, and optional snapshotId.

Instructions

Step 1: Identify your share

List all shares in your target region to find the share ID:

Confirm that the share is in available state before creating snapshots.

Step 2: List existing snapshots

Retrieve all snapshots for a given share:

Use the response to retrieve snapshot IDs and statuses before deleting or automating operations.

Step 3: Create a snapshot

Create a snapshot with a JSON payload specifying a human-readable name (and optional description):

• Poll the list/detail endpoints until the snapshot reaches available status.
• Snapshot creation time depends on allocated capacity, I/O activity, and platform load.
• Plan snapshots during low I/O periods to ensure consistency.

Step 4: Retrieve snapshot details (optional)

Retrieve a single snapshot by ID:

Use this for automated checks after backups or to verify snapshot metadata.

Step 5: Delete a snapshot

Free the storage consumed by a snapshot:

Go further

• File Storage Service – Key Concepts
• File Storage Service – Getting Started
• Preparing an environment for using the OpenStack API

Join our community of users.