File Storage Service - Managing share snapshots

 

Requirements

• A Public Cloud project with File Storage Service enabled.
• An existing share in the 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 the 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):

• Execute the API call in Step 2 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

Browse all the File Storage guides.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about File Storage on the OVHcloud US website.