ListBackupVaults - 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.

ListBackupVaults

Renvoie une liste des conteneurs de stockage de points de récupération ainsi que des informations les concernant.

Syntaxe de la demande

GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

ByShared

Ce paramètre triera la liste des coffres-forts par coffres-forts partagés.

ByVaultType

Ce paramètre triera la liste des coffres-forts par type de coffre-fort.

Valeurs valides : BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

MaxResults

Le nombre maximum d'éléments à renvoyer.

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

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

{
   "BackupVaultList": [ 
      { 
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "EncryptionKeyArn": "string",
         "LockDate": number,
         "Locked": boolean,
         "MaxRetentionDays": number,
         "MinRetentionDays": number,
         "NumberOfRecoveryPoints": number
      }
   ],
   "NextToken": "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.

BackupVaultList

Un tableau des membres du coffre-fort de sauvegarde contenant les métadonnées du coffre-fort, notamment l'Amazon Resource Name (ARN), le nom d'affichage, la date de création, le nombre de points de récupération enregistrés et les informations de chiffrement si les ressources enregistrées dans le coffre-fort de sauvegarde sont chiffrées.

Type : tableau d’objets BackupVaultListMember

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

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 :