Obtenir des informations sur vos snapshots

Vous pouvez obtenir des informations sur vos snapshots en utilisant AWS CLI.

Obtenir des informations sur vos snapshots avec Cockpit v2

Voir le dashboard Snapshots.

Obtenir des informations sur vos snapshots avec OSC CLI

À ce jour, cette section est disponible en anglais uniquement.

The ReadSnapshots command lists one or more snapshots that are available to you and the permissions to create volumes from them.

Request sample
$ osc-cli api ReadSnapshots --profile "default" \
    --Filters '{
        "SnapshotIds": ["snap-12345678"]
      }'
Request sample
$ osc-cli api ReadSnapshots --profile "default" \
    --Filters '{
        "TagKeys": ["env"],
        "TagValues": ["prod", "test"]
      }'

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

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • AccountAliases: (optional) The account aliases of the owners of the snapshots.

    • AccountIds: (optional) The account IDs of the owners of the snapshots.

    • Descriptions: (optional) The descriptions of the snapshots.

    • FromCreationDate: (optional) The beginning of the time period, in ISO 8601 date-time format (for example, 2020-06-14T00:00:00.000Z).

    • PermissionsToCreateVolumeAccountIds: (optional) The account IDs which have permissions to create volumes.

    • PermissionsToCreateVolumeGlobalPermission: (optional) If true, lists all public volumes. If false, lists all private volumes.

    • Progresses: (optional) The progresses of the snapshots, as a percentage.

    • SnapshotIds: (optional) The IDs of the snapshots.

    • States: (optional) The states of the snapshots (in-queue | pending | completed | error | deleting).

    • TagKeys: (optional) The keys of the tags associated with the snapshots.

    • TagValues: (optional) The values of the tags associated with the snapshots.

    • Tags: (optional) The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

    • ToCreationDate: (optional) The end of the time period, in ISO 8601 date-time format (for example, 2020-06-30T00:00:00.000Z).

    • VolumeIds: (optional) The IDs of the volumes used to create the snapshots.

    • VolumeSizes: (optional) The sizes of the volumes used to create the snapshots, in gibibytes (GiB).

  • NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.

  • ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadSnapshots command returns the following elements:

  • NextPageToken: The token to request the next page of results. Each token refers to a specific page.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

  • Snapshots: Information about one or more snapshots and their permissions.

    • AccountAlias: The account alias of the owner of the snapshot.

    • AccountId: The account ID of the owner of 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
{
  "Snapshots": [
    {
      "VolumeSize": 10,
      "AccountId": "123456789012",
      "VolumeId": "vol-12345678",
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "PermissionsToCreateVolume": {
        "GlobalPermission": false,
        "AccountIds": []
      },
      "Progress": 100,
      "SnapshotId": "snap-12345678",
      "State": "completed",
      "Description": "Snapshot created from a volume",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}
Result sample
{
  "Snapshots": [
    {
      "VolumeSize": 10,
      "AccountId": "123456789012",
      "VolumeId": "vol-12345678",
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "PermissionsToCreateVolume": {
        "GlobalPermission": false,
        "AccountIds": []
      },
      "Progress": 100,
      "SnapshotId": "snap-12345678",
      "State": "completed",
      "Description": "Test snapshot",
      "Tags": [
        {
          "Value": "test",
          "Key": "env"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Obtenir des informations sur vos snapshots avec oapi-cli

À ce jour, cette section est disponible en anglais uniquement.

The ReadSnapshots command lists one or more snapshots that are available to you and the permissions to create volumes from them.

Request sample
$ oapi-cli --profile "default" ReadSnapshots \
    --Filters '{
        "SnapshotIds": ["snap-12345678"]
      }'
Request sample
$ oapi-cli --profile "default" ReadSnapshots \
    --Filters '{
        "TagKeys": ["env"],
        "TagValues": ["prod", "test"]
      }'

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

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • AccountAliases: (optional) The account aliases of the owners of the snapshots.

    • AccountIds: (optional) The account IDs of the owners of the snapshots.

    • Descriptions: (optional) The descriptions of the snapshots.

    • FromCreationDate: (optional) The beginning of the time period, in ISO 8601 date-time format (for example, 2020-06-14T00:00:00.000Z).

    • PermissionsToCreateVolumeAccountIds: (optional) The account IDs which have permissions to create volumes.

    • PermissionsToCreateVolumeGlobalPermission: (optional) If true, lists all public volumes. If false, lists all private volumes.

    • Progresses: (optional) The progresses of the snapshots, as a percentage.

    • SnapshotIds: (optional) The IDs of the snapshots.

    • States: (optional) The states of the snapshots (in-queue | pending | completed | error | deleting).

    • TagKeys: (optional) The keys of the tags associated with the snapshots.

    • TagValues: (optional) The values of the tags associated with the snapshots.

    • Tags: (optional) The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

    • ToCreationDate: (optional) The end of the time period, in ISO 8601 date-time format (for example, 2020-06-30T00:00:00.000Z).

    • VolumeIds: (optional) The IDs of the volumes used to create the snapshots.

    • VolumeSizes: (optional) The sizes of the volumes used to create the snapshots, in gibibytes (GiB).

  • NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.

  • ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadSnapshots command returns the following elements:

  • NextPageToken: The token to request the next page of results. Each token refers to a specific page.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

  • Snapshots: Information about one or more snapshots and their permissions.

    • AccountAlias: The account alias of the owner of the snapshot.

    • AccountId: The account ID of the owner of 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
{
  "Snapshots": [
    {
      "VolumeSize": 10,
      "AccountId": "123456789012",
      "VolumeId": "vol-12345678",
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "PermissionsToCreateVolume": {
        "GlobalPermission": false,
        "AccountIds": []
      },
      "Progress": 100,
      "SnapshotId": "snap-12345678",
      "State": "completed",
      "Description": "Snapshot created from a volume",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}
Result sample
{
  "Snapshots": [
    {
      "VolumeSize": 10,
      "AccountId": "123456789012",
      "VolumeId": "vol-12345678",
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "PermissionsToCreateVolume": {
        "GlobalPermission": false,
        "AccountIds": []
      },
      "Progress": 100,
      "SnapshotId": "snap-12345678",
      "State": "completed",
      "Description": "Test snapshot",
      "Tags": [
        {
          "Value": "test",
          "Key": "env"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Obtenir des informations sur vos snapshots avec AWS CLI

Avant de commencer : Installez et configurez AWS CLI. Pour en savoir plus, voir Installer et configurer AWS CLI.

Obtenir des informations générales sur vos snapshots

Vous pouvez obtenir des informations à propos d’un snapshot, telles que l’ID du volume à partir duquel il a été créé, les tags qui lui sont associés, ou son état.

Pour obtenir des informations sur vos snapshots, utilisez la commande describe-snapshots en suivant cette syntaxe :

Exemple de requête
$ aws ec2 describe-snapshots \
    --profile YOUR_PROFILE  \
    --snapshot-id snap-12345678 \
    --filters Name=TAG_NAME,Values=TAG_VALUE \
    --endpoint https://fcu.eu-west-2.outscale.com

Cette commande contient les attributs suivants que vous devez spécifier :

  • (optionnel) profile : Le profil nommé que vous voulez utiliser, créé pendant la configuration d’AWS CLI. Pour en savoir plus, voir Installer et configurer AWS CLI.

  • (optionnel) snapshot-id : Un ou plusieurs ID de snapshots. Si aucun ID de snapshot n’est spécifié, la requête renvoie une description de l’ensemble de vos snapshots.

  • (optionnel) filters : Un ou plusieurs filtres, au format "Name=X,Values=Y".

    Vous pouvez spécifier plusieurs valeurs pour un même filtre en utilisant le format "Name=X,Values=Y, Z".

    Les filtres suivants sont disponibles :

    • description : La description du snapshot.

    • owner-alias : L’account alias du propriétaire du snapshot.

    • owner-id : L’ID de compte du propriétaire du snapshot.

    • progress : La progression du snapshot, en pourcentage.

    • snapshot-id : L’ID du snapshot.

    • start-time : L’heure à laquelle le snapshot a été lancé.

    • status : L’état du snapshot (in-queue | completed | error).

    • volume-id : L’ID du volume utilisé pour créer le snapshot.

    • volume-size : La taille du volume utilisé pour créer le snapshot, en gibioctets (Gio).

    • tag-key : La clé d’un tag associé à la ressource.

    • tag-value : La valeur d’un tag associé à la ressource.

    • tag:XXXX : La valeur d’un tag associé à la ressource, où XXXX est la clé du tag.

      Pour filtrer un tag dont la clé est XXXX et la valeur est YYYY, vous pouvez donc utiliser un des deux formats suivants :

      • --filters Name=tag-key,Values=XXXX Name=tag-value,Values=YYYY

      • --filters Name=tag:XXXX,Values=YYYY

  • endpoint : Le endpoint correspondant à la Région à laquelle vous voulez envoyer la requête. Pour en savoir plus, voir Installer et configurer AWS CLI.

La commande describe-snapshots renvoie les éléments suivants :

  • Description : La description du snapshot.

  • Encrypted : Le chiffrement d’un volume (true | false).

  • Tags : Un ou plusieurs tags associés au snapshot.

  • VolumeId : L’ID du volume.

  • State : L’état du snapshot.

  • VolumeSize : La taille du volume utilisé pour créer le snapshot, en gibioctets (Gio).

  • Progress : La progression du snapshot, en pourcentage.

  • SnapshotId : L’ID du snapshot.

  • OwnerId : L’ID du compte propriétaire du snapshot.

Exemple de résultat
{
    "Description": "Created by CreateImage i-12345678 for ami-12345678 from volume-12345678",
    "Encrypted": false,
    "Tags": [],
    "VolumeId": "vol-12345678",
    "State": "completed",
    "VolumeSize": 10,
    "Progress": "100%",
    "SnapshotId": "snap-87654321",
    "OwnerId": "123456789012"
}

Obtenir des informations sur les permissions pour un snapshot

Vous pouvez obtenir des informations sur la liste des comptes autorisés à créer un volume à partir d’un snapshot spécifique. Vous pouvez modifier ces autorisations à tout moment. Pour en savoir plus, voir Gérer les permissions pour un snapshot.

Pour obtenir des informations sur les permissions d’un snapshot, utilisez la commande describe-snapshot-attribute en suivant cette syntaxe :

Exemple de requête
$ aws ec2 describe-snapshot-attribute \
    --profile YOUR_PROFILE \
    --snapshot-id snap-12345678 \
    --attribute createVolumePermission \
    --endpoint https://fcu.eu-west-2.outscale.com

Cette commande contient les attributs suivants que vous devez spécifier :

  • (optionnel) profile : Le profil nommé que vous voulez utiliser, créé pendant la configuration d’AWS CLI. Pour en savoir plus, voir Installer et configurer AWS CLI.

  • snapshot-id : L’ID du snapshot.

  • attribute : L’attribut du snapshot pour lequel vous souhaitez obtenir des informations (doit être paramétré sur createVolumePermission).

  • endpoint : Le endpoint correspondant à la Région à laquelle vous voulez envoyer la requête. Pour en savoir plus, voir Installer et configurer AWS CLI.

La commande describe-snapshot-attribute renvoie les éléments suivants :

  • SnapshotId : L’ID du snapshot.

  • CreateVolumePermission : Les informations à propos d’une ou plusieurs permissions de créer un volume à partir du snapshot. Cet élément contient les informations suivantes :

    • UserId : Un ou plusieurs ID de comptes avec lesquels vous avez partagé le snapshot.

    • Group : Le nom du groupe avec lequel vous avez partagé le snapshot (all si public, sinon laissé vide).

Exemple de résultat
{
    "SnapshotId": "snap-1234578",
    "CreateVolumePermissions": [
        {
            "UserId": "1234567899999",
            "Group": "",
        }
    ]
}

Pages connexes

Méthodes API correspondantes

AWS™ et Amazon Web Services™ sont des marques de commerce d'Amazon Technologies, Inc. ou de ses affiliées aux États-Unis et/ou dans les autres pays.