Skip to main content
Element Software
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

CreateSnapshot

Contributeurs
PDF 
`CreateSnapshot`Permet de créer une copie instantanée d'un volume. Vous pouvez créer un snapshot à partir de n'importe quel volume ou d'un snapshot existant.

Si vous ne fournissez pas de SnapshotID avec cette méthode API, un snapshot est créé à partir de la branche active du volume. Si le volume à partir duquel le snapshot est créé est répliqué sur un cluster distant, le snapshot peut également être répliqué sur la même cible. Utilisez le paramètre enableRemoteReplication pour activer la réplication de snapshot.

Remarque Vous pouvez créer des instantanés si la plénitude de cluster est aux étapes 1, 2 ou 3. Vous ne pouvez pas créer de snapshots lorsque la plénitude de cluster atteint l'étape 4 ou 5.

Paramètres

Cette méthode présente les paramètres d'entrée suivants :

Nom Description Type Valeur par défaut Obligatoire

attributes

Liste des paires nom-valeur au format d'objet JSON.

Objet JSON

Aucune

Non

enableRemoteReplication

Indique si le snapshot sera répliqué sur le stockage distant ou non. Valeurs possibles :

  • true: Le snapshot sera répliqué sur le stockage distant.

  • false: Le snapshot ne sera pas répliqué sur le stockage distant.

booléen

faux

Non

ensureSerialCreation

Indique que le snapshot ne doit pas être créé si une réplication de snapshot précédente est en cours. Les valeurs possibles sont :

  • true: Cela garantit qu'un seul snapshot est répliqué à la fois. La création d'un nouvel instantané échoue si une réplication de snapshot précédente est toujours en cours.

  • false: Par défaut. La création de ce snapshot est autorisée si une autre réplication de snapshot est en cours.

booléen

false

Non

Heure d'expiration

Spécifiez l'heure après laquelle le snapshot peut être supprimé. Ne peut pas être utilisé avec retention. Si aucune date d'expiration ou de conservation n'est spécifiée, le snapshot n'expire pas. Le format d'heure est une chaîne de date ISO 8601 pour l'expiration basée sur le temps, sinon elle n'expire pas. Une valeur de entraîne la conservation permanente de null l'instantané. La valeur de fifo permet de conserver le snapshot selon le principe Premier entré, Premier sorti, par rapport aux autres snapshots FIFO du volume. L'API échoue si aucun espace FIFO n'est disponible.

chaîne

Aucune

Non

name

Nom du snapshot. Si aucun nom n'est saisi, la date et l'heure de prise de l'instantané sont utilisées. La longueur maximale autorisée pour le nom est de 255 caractères.

chaîne

Aucune

Non

retention

Ce paramètre est le même que le expirationTime paramètre, sauf que le format de l'heure est HH:mm:ss. Si aucune des deux retention valeurs n' `expirationTime`est spécifiée, le snapshot n'expire pas.

chaîne

Aucune

Non

snapMirrorLabel

Étiquette utilisée par le logiciel SnapMirror pour spécifier la règle de conservation des snapshots sur un terminal SnapMirror.

chaîne

Aucune

Non

snapshotID

ID unique d'un snapshot à partir duquel le nouvel instantané est créé. L'ID de snapshot réussi doit être un snapshot sur le volume donné.

entier

Aucune

Non

volumeID

ID unique de l'image de volume à copier.

entier

Aucune

Oui

Valeurs de retour

Cette méthode a les valeurs de retour suivantes :

Nom

Description

Type

somme de contrôle

Chaîne qui représente les chiffres corrects du snapshot stocké. Cette somme de contrôle peut être utilisée ultérieurement pour comparer d'autres instantanés afin de détecter des erreurs dans les données.

chaîne

ID de snapshot

ID unique du nouvel instantané.

ID de snapshot

snapshot

Objet contenant des informations sur le nouveau snapshot.

snapshot

Exemple de demande

Les demandes pour cette méthode sont similaires à l'exemple suivant :

{
   "method": "CreateSnapshot",
   "params": {
      "volumeID": 1
   },
   "id": 1
}

Exemple de réponse

Cette méthode renvoie une réponse similaire à l'exemple suivant :

{
  "id": 1,
  "result": {
    "checksum": "0x0",
      "snapshot": {
        "attributes": {},
        "checksum": "0x0",
        "createTime": "2016-04-04T17:14:03Z",
        "enableRemoteReplication": false,
        "expirationReason": "None",
        "expirationTime": null,
        "groupID": 0,
        "groupSnapshotUUID": "00000000-0000-0000-0000-000000000000",
        "name": "2016-04-04T17:14:03Z",
        "snapshotID": 3110,
        "snapshotUUID": "6f773939-c239-44ca-9415-1567eae79646",
        "status": "done",
        "totalSize": 5000658944,
        "virtualVolumeID": null,
        "volumeID": 1
      },
        "snapshotID": 3110
  }
}

Exception

Une exception xNotPrimary s'affiche lorsque l'API est appelée et que CreateSnapshot l'instantané ne peut pas être créé. Il s'agit d'un comportement attendu. Relancez l' `CreateSnapshot`appel API.

Nouveau depuis la version

9,6