CreateBackupPlan - AWS Backup
Syntaxe de la requêteURIParamètres de demandeCorps de la requêteSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateBackupPlan

Crée un plan de sauvegarde à l'aide d'un nom de plan de sauvegarde et de règles de sauvegarde. Un plan de sauvegarde est un document qui contient des informations permettant de AWS Backup planifier des tâches qui créent des points de récupération pour les ressources.

Si vous appelez CreateBackupPlan avec un plan qui existe déjà, vous recevez une exception AlreadyExistsException.

Syntaxe de la requête

PUT /backup/plans/ HTTP/1.1
Content-type: application/json

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string"
         }
      ]
   },
   "BackupPlanTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string"
}

URIParamètres de demande

La demande n'utilise aucun URI paramètre.

Corps de la requête

La demande accepte les données suivantes au JSON format suivant.

BackupPlan

Le corps d'un plan de secours. Comprend un BackupPlanName et un ou plusieurs ensembles de Rules.

Type : objet BackupPlanInput

Obligatoire : oui

BackupPlanTags

Les balises à attribuer au plan de sauvegarde.

Type : mappage chaîne/chaîne

Obligatoire : non

CreatorRequestId

Identifie la demande et permet de réessayer les demandes ayant échoué sans risque d'exécuter l'opération deux fois. Si la demande inclut un CreatorRequestId qui correspond à un plan de sauvegarde existant, ce plan est renvoyé. Ce paramètre est facultatif.

S'il est utilisé, ce paramètre doit contenir de 1 à 50 caractères alphanumériques ou « -_. » caractères.

Type : chaîne

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "VersionId": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées sous JSON forme formatée par le service.

AdvancedBackupSettings

Les paramètres d'un type de ressource. Cette option n'est disponible que pour les tâches de sauvegarde Windows Volume Shadow Copy Service (VSS).

Type : tableau d’objets AdvancedBackupSetting

BackupPlanArn

Nom de ressource Amazon (ARN) qui identifie de manière unique un plan de sauvegarde ; par exemple,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Type : String

BackupPlanId

L'ID du plan de sauvegarde.

Type : String

CreationDate

Date et heure de création d'un plan de sauvegarde, au format Unix et en temps universel coordonné (UTC). La valeur de CreationDate est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

VersionId

Chaînes uniques, générées aléatoirement, Unicode, codées en UTF -8, d'une longueur maximale de 1 024 octets. Ils ne peuvent pas être modifiés.

Type : String

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AlreadyExistsException

La ressource demandée existe déjà.

HTTPCode de statut : 400

InvalidParameterValueException

Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.

HTTPCode de statut : 400

LimitExceededException

Une limite de la demande a été dépassée ; par exemple, le nombre maximum d'éléments autorisés dans une demande.

HTTPCode de statut : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

HTTPCode de statut : 400

ServiceUnavailableException

La demande a échoué en raison d'une défaillance temporaire du serveur.

HTTPCode de statut : 500

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :