GetBackupPlan - AWS Backup
Syntaxe de la demandeParamètres de demande URICorps 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.

GetBackupPlan

Renvoie les informations BackupPlan pour l'BackupPlanId spécifié. Les informations constituent le corps d'un plan de sauvegarde au format JSON, en plus des métadonnées.

Syntaxe de la demande

GET /backup/plans/backupPlanId/?versionId=VersionId HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

backupPlanId

Identifie de façon unique un plan de secours.

Obligatoire : oui

VersionId

Chaînes codées en Unicode, UTF-8 et générées de façon aléatoire qui contiennent au maximum 1 024 octets. Les ID de version ne peuvent pas être modifiés.

Corps de la requête

La demande n’a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "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" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string"
         }
      ]
   },
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "DeletionDate": number,
   "LastExecutionDate": 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 au format JSON par le service.

AdvancedBackupSettings

Contient une liste d'BackupOptions pour chaque type de ressource. La liste est renseignée uniquement si l'option avancée est définie pour le plan de sauvegarde.

Type : tableau d’objets AdvancedBackupSetting

BackupPlan

Spécifie le corps d'un plan de sauvegarde. Comprend un BackupPlanName et un ou plusieurs ensembles de Rules.

Type : objet BackupPlan

BackupPlanArn

Amazon Resource Name (ARN) qui identifie de façon unique un plan de secours ; par exemple, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Type : chaîne

BackupPlanId

Identifie de façon unique un plan de secours.

Type : chaîne

CreationDate

Date et heure de création d'un plan de sauvegarde, au format Unix et au format UTC (temps universel coordonné). 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

CreatorRequestId

Une chaîne unique qui identifie la demande et permet de réessayer les demandes ayant échoué sans risque d'exécuter l'opération deux fois.

Type : chaîne

DeletionDate

Date et heure de suppression d'un plan de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de DeletionDate 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

LastExecutionDate

La dernière fois que ce plan de sauvegarde a été exécuté. Date et heure au format Unix et UTC (temps universel coordonné). La valeur de LastExecutionDate 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 codées en Unicode, UTF-8 et générées de façon aléatoire qui contiennent au maximum 1 024 octets. Les ID de version ne peuvent pas être modifiés.

Type : chaîne

Erreurs

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

InvalidParameterValueException

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

Code d’état HTTP : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

Code d’état HTTP : 400

ResourceNotFoundException

Aucune ressource requise pour l'action n'existe.

Code d’état HTTP : 400

ServiceUnavailableException

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

Code d’état HTTP : 500

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :