Enterprise File Storage - Managing volume snapshots

Manage Enterprise File Storage volume snapshots using the OVHcloud API

Last updated 27th October 2021

Objective

In this tutorial, we will provide an overview of how to manage snapshots for OVHcloud Enterprise File Storage volumes.

Learn how to list snapshots, create a new snapshot, get information about a snapshot and remove a snapshot using the OVHcloud API.

Requirements

  • An OVHcloud Enterprise File Storage offer with an available volume
  • You should be logged in to the OVHcloud API

Basics

A volume snapshot is a point-in-time, read-only copy of a volume.

Snapshots are created from an existing, operational volume.

Snapshots are linked to a volume, they cannot exist without it.

Instructions

All API routes used for this turorial are available under the /storage section here: https://api.ovh.com/console/#/storage.

While using the API, all fields marked with an asterisk (*) are required.

Listing existing snapshots for a volume

All existing snapshots for a volume can be retrieved using the following route:

API:
Parameters:

serviceName *

Service ID

shareId *

Volume ID

Replace serviceName with the ID of your service and shareId with your volume ID.

You should have no snapshots by default.

Creating a new snapshot from a volume

To create a new snapshot, use the following route:

API:
Parameters:

serviceName *

Service ID

shareId *

Volume ID

NetAppShareSnapshot *

description

Snapshot description

name

Snapshot name

Replace serviceName with the ID of your service and shareId with your volume ID.

Both snapshot name and description parameters are optional.

Get information about a snapshot

To get information about a snapshot, use the following route:

API:
Parameters:

serviceName *

Service ID

shareId *

Volume ID

snapshotId *

Snapshot ID

Replace serviceName with the ID of your service, shareId with your volume ID and snapshotId with your snapshot ID.

Removing a snapshot

To remove a snapshot, use the following route:

API:
Parameters:

serviceName *

Service ID

shareId *

Volume ID

snapshotId

Snapshot ID

Replace serviceName with the ID of your service, shareId with your volume ID and snapshotId with your snapshot ID.

Go further

Join our community of users on https://community.ovh.com/en/.


Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.


These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community

In accordance with the 2006/112/CE Directive, modified on 01/01/2015, prices exclude VAT. VAT may vary according to the customer's country of residence.