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/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&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
- MaxScheduledRunsPreview
-
Nombre de futures sauvegardes planifiées à prévisualiser. Lorsque ce paramètre est défini sur 0 (par défaut), aucun aperçu des courses planifiées n'est inclus dans la réponse. La plage valide est comprise entre 0 et 10.
Plage valide : Valeur minimum de 0. Valeur maximale fixée à 10.
- 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. La version IDs ne peut pas être modifiée.
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,
"IndexActions": [
{
"ResourceTypes": [ "string" ]
}
],
"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,
"ScheduledRunsPreview": [
{
"ExecutionTime": number,
"RuleExecutionType": "string",
"RuleId": "string"
}
],
"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'
BackupOptionspour 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
BackupPlanNameet un ou plusieurs ensembles deRules.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 : String
- BackupPlanId
-
Identifie de façon unique un plan de secours.
Type : String
- 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
CreationDateest 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 : String
- DeletionDate
-
Date et heure de suppression d'un plan de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de
DeletionDateest 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
LastExecutionDateest 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
- ScheduledRunsPreview
-
Liste des prochaines exécutions de sauvegarde planifiées. Inclus uniquement lorsque
MaxScheduledRunsPreviewle paramètre est supérieur à 0. Contient jusqu'à 10 futures exécutions de sauvegarde avec leurs heures planifiées, leurs types d'exécution et la règle associée IDs.Type : tableau d’objets ScheduledPlanExecutionMember
- 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. La version IDs ne peut pas être modifiée.
Type : String
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.
- Context
- Type
Code d’état HTTP : 400
- MissingParameterValueException
-
Indique qu'un paramètre obligatoire est manquant.
- Context
- Type
Code d’état HTTP : 400
- ResourceNotFoundException
-
Aucune ressource requise pour l'action n'existe.
- Context
- Type
Code d’état HTTP : 400
- ServiceUnavailableException
-
La demande a échoué en raison d'une défaillance temporaire du serveur.
- Context
- Type
Code d’état HTTP : 500
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
