Creating a Snapshot of a Volume

You can create a snapshot of a volume to make a point-in-time image of the data stored on this volume. You can then create a new volume based on this snapshot, copy it to another Region or share it with other accounts.

In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.

Creating a Snapshot of a Volume Using Cockpit v2

You can also do this action in the Volumes dashboard, by selecting a volume and clicking IconAddFull Create Snapshot in the displayed menu.

In the Snapshots dashboard, click Create Snapshot.
The CREATE SNAPSHOT dialog box appears.
In the Name field, type a name for the snapshot.

This action adds a Name tag of 255 characters maximum. You can use any character, including accented letters.
(optional) In the Description field, type a description of the snapshot.
From the Volume list, select the volume of which you want to create a snapshot.

If data is being written on the volume at the time you create the snapshot, this snapshot may be incomplete.
Click Create Snapshot.
The snapshot is created.

Creating a Snapshot of a Volume Using OSC CLI

The CreateSnapshot command creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
You can use this method in three different ways:

Creating from a volume: You create a snapshot from one of your volumes.
Copying a snapshot: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the UpdateSnapshot method.
Importing from a bucket: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the CreateSnapshotExportTask method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see Creating a Pre-Signed URL.

In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.

For more information, see About Snapshots.

Request sample: Creating from a volume

$ osc-cli api CreateSnapshot --profile "default" \
    --VolumeId "vol-12345678" \
    --Description "Snapshot created from a volume"

This command contains the following attributes that you need to specify:

Description: (optional) A description for the snapshot.
DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
VolumeId: (optional) (when creating from a volume) The ID of the volume you want to create a snapshot of.

The CreateSnapshot command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
Snapshot: Information about the snapshot.
- AccountAlias: The account alias of the owner of the snapshot.
- AccountId: The account ID of the owner of the snapshot.
- ClientToken: The idempotency token provided when creating the snapshot.
- CreationDate: The date and time (UTC) at which the snapshot was created.
- Description: The description of the snapshot.
- PermissionsToCreateVolume: Permissions for the resource.
  - AccountIds: One or more account IDs that the permission is associated with.
  - GlobalPermission: A global permission for all accounts.
    (Request) Set this parameter to true to make the resource public (if the parent parameter is Additions) or to make the resource private (if the parent parameter is Removals).
    (Response) If true, the resource is public. If false, the resource is private.
- Progress: The progress of the snapshot, as a percentage.
- SnapshotId: The ID of the snapshot.
- State: The state of the snapshot (in-queue | pending | completed | error | deleting)).
- Tags: One or more tags associated with the snapshot.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
- VolumeId: The ID of the volume used to create the snapshot.
- VolumeSize: The size of the volume used to create the snapshot, in gibibytes (GiB).

Result sample: Creating from a volume

{
  "Snapshot": {
    "VolumeSize": 10,
    "AccountId": "123456789012",
    "VolumeId": "vol-12345678",
    "CreationDate": "2010-10-01T12:34:56.789Z",
    "PermissionsToCreateVolume": {
      "GlobalPermission": false,
      "AccountIds": []
    },
    "Progress": 0,
    "SnapshotId": "snap-12345678",
    "State": "pending/queued",
    "Description": "Snapshot created from a volume",
    "Tags": []
  },
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Creating a Snapshot of a Volume Using oapi-cli

Creating from a volume: You create a snapshot from one of your volumes.
Copying a snapshot: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the UpdateSnapshot method.
Importing from a bucket: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the CreateSnapshotExportTask method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see Creating a Pre-Signed URL.

In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.

For more information, see About Snapshots.

Request sample: Creating from a volume

$ oapi-cli --profile "default" CreateSnapshot \
    --VolumeId "vol-12345678" \
    --Description "Snapshot created from a volume"

This command contains the following attributes that you need to specify:

Description: (optional) A description for the snapshot.
DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
VolumeId: (optional) (when creating from a volume) The ID of the volume you want to create a snapshot of.

The CreateSnapshot command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
Snapshot: Information about the snapshot.
- AccountAlias: The account alias of the owner of the snapshot.
- AccountId: The account ID of the owner of the snapshot.
- ClientToken: The idempotency token provided when creating the snapshot.
- CreationDate: The date and time (UTC) at which the snapshot was created.
- Description: The description of the snapshot.
- PermissionsToCreateVolume: Permissions for the resource.
  - AccountIds: One or more account IDs that the permission is associated with.
  - GlobalPermission: A global permission for all accounts.
    (Request) Set this parameter to true to make the resource public (if the parent parameter is Additions) or to make the resource private (if the parent parameter is Removals).
    (Response) If true, the resource is public. If false, the resource is private.
- Progress: The progress of the snapshot, as a percentage.
- SnapshotId: The ID of the snapshot.
- State: The state of the snapshot (in-queue | pending | completed | error | deleting)).
- Tags: One or more tags associated with the snapshot.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
- VolumeId: The ID of the volume used to create the snapshot.
- VolumeSize: The size of the volume used to create the snapshot, in gibibytes (GiB).

Result sample: Creating from a volume

{
  "Snapshot": {
    "VolumeSize": 10,
    "AccountId": "123456789012",
    "VolumeId": "vol-12345678",
    "CreationDate": "2010-10-01T12:34:56.789Z",
    "PermissionsToCreateVolume": {
      "GlobalPermission": false,
      "AccountIds": []
    },
    "Progress": 0,
    "SnapshotId": "snap-12345678",
    "State": "pending/queued",
    "Description": "Snapshot created from a volume",
    "Tags": []
  },
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Creating a Snapshot of a Volume Using AWS CLI

Before you begin: Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.

To create a snapshot of a specified volume, use create-snapshot command following this syntax:

Request sample

$ aws ec2 create-snapshot \
    --profile YOUR_PROFILE \
    --volume-id vol-12345678 \
    --description snapshot of vol-12345678 \
    --endpoint https://fcu.eu-west-2.outscale.com

This command contains the following options that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
volume-id: The ID of the volume you want to create a snapshot of.
(optional) description: A description of the snapshot.
endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The create-snapshot command returns the following elements:

Description: A description of the snapshot, if provided in the request.
OwnerId: The account ID of the owner of the snapshot.
Progress: The progress of the snapshot (a percentage).
SnapshotId: The ID of the newly created snapshot.
State: The state of the snapshot (in-queue | pending | completed).
StartTime: The time at which the snapshot was initiated.
VolumeId: The ID of the volume used to create the snapshot.
VolumeSize: The size of the volume, in gibibytes (GiB).

Result sample

{
    "Description": "snapshot of vol-12345678",
    "Progress": "0%",
    "OwnerId": "123456789012",
    "SnapshotId": "snap-87654321",
    "StartTime": "2018-03-26T13:01:33.176Z",
    "State": "pending",
    "VolumeId": "vol-12345678",
    "VolumeSize": 50
}

A snapshot of the specified volume is created.

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.