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.
DescribeBackupVault
Renvoie les métadonnées relatives à un coffre-fort de sauvegarde spécifié par son nom.
Syntaxe de la requête
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
URIParamètres de demande
La demande utilise les URI paramètres suivants.
- BackupVaultAccountId
-
ID de compte du coffre-fort de sauvegarde spécifié.
- backupVaultName
-
Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms spécifiques pour le compte utilisé pour les créer et la région AWS dans laquelle ils sont créés.
Obligatoire : oui
Corps de la demande
La demande n’a pas de corps de requête.
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"EncryptionKeyArn": "string",
"LockDate": number,
"Locked": boolean,
"MaxRetentionDays": number,
"MinRetentionDays": number,
"NumberOfRecoveryPoints": number,
"VaultState": "string",
"VaultType": "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.
- BackupVaultArn
-
Nom de ressource Amazon (ARN) qui identifie de manière unique un coffre-fort de sauvegarde ; par exemple,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.Type : String
- BackupVaultName
-
Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms spécifiques pour le compte utilisé pour les créer et la région dans laquelle ils sont créés.
Type : String
- CreationDate
-
Date et heure de création d'un coffre-fort de sauvegarde, au format Unix et en temps universel coordonné (UTC). 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. 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 : String
- EncryptionKeyArn
-
Chiffrement côté serveur utilisé pour protéger vos sauvegardes ; par exemple,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.Type : String
- LockDate
-
Date et heure auxquelles la configuration de AWS Backup Vault Lock ne peut pas être modifiée ou supprimée.
Si vous avez appliqué Vault Lock à votre coffre-fort sans spécifier de date de verrouillage, vous pouvez modifier les paramètres de Vault Lock ou supprimer complètement Vault Lock du coffre-fort à tout moment.
Cette valeur est au format Unix, temps universel coordonné (UTC) et 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
- Locked
-
Un booléen qui indique si AWS Backup Vault Lock protège actuellement le coffre-fort de sauvegarde.
Truesignifie que Vault Lock entraîne l'échec des opérations de suppression ou de mise à jour sur les points de récupération stockés dans le coffre-fort.Type : booléen
- MaxRetentionDays
-
Le paramètre AWS Backup Vault Lock qui spécifie la période de rétention maximale pendant laquelle le coffre-fort conserve ses points de récupération. Si ce paramètre n'est pas spécifié, Vault Lock n'applique pas de période de rétention maximale sur les points de récupération dans le coffre-fort (permettant un stockage indéfini).
S'il est spécifié, toute tâche de sauvegarde ou de copie vers le coffre-fort doit avoir une politique de cycle de vie avec une période de rétention égale ou inférieure à la période de rétention maximale. Si la période de conservation de la tâche est plus longue que cette période de conservation maximale, la tâche de sauvegarde ou de copie du coffre-fort échoue, et vous devez soit modifier vos paramètres de cycle de vie, soit utiliser un autre coffre-fort. Les points de récupération déjà stockés dans le coffre-fort avant Vault Lock ne sont pas affectés.
Type : long
- MinRetentionDays
-
Le paramètre AWS Backup Vault Lock qui spécifie la période de rétention minimale pendant laquelle le coffre-fort conserve ses points de récupération. Si ce paramètre n'est pas spécifié, le verrouillage du coffre-fort n'appliquera pas de période de conservation minimale.
S'il est spécifié, toute tâche de sauvegarde ou de copie vers le coffre-fort doit avoir une politique de cycle de vie avec une période de rétention égale ou supérieure à la période de rétention minimale. Si la période de rétention de la tâche est plus courte que cette période de rétention minimale, la tâche de sauvegarde ou de copie du coffre-fort échoue et vous devez soit modifier vos paramètres de cycle de vie, soit utiliser un autre coffre-fort. Les points de récupération déjà stockés dans le coffre-fort avant Vault Lock ne sont pas affectés.
Type : long
- NumberOfRecoveryPoints
-
Nombre de points de récupération stockés dans un coffre-fort de sauvegarde.
Type : long
- VaultState
-
État actuel du coffre. ->
Type : String
Valeurs valides :
CREATING | AVAILABLE | FAILED - VaultType
-
Type de coffre décrit.
Type : String
Valeurs valides :
BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT
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.
HTTPCode de statut : 400
- MissingParameterValueException
-
Indique qu'un paramètre obligatoire est manquant.
HTTPCode de statut : 400
- ResourceNotFoundException
-
Aucune ressource requise pour l'action n'existe.
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 :
