ListBackupVaults
Devuelve una lista de contenedores de almacenamiento de puntos de recuperación junto con información sobre ellos.
Sintaxis de la solicitud
GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
-
Este parámetro ordenará la lista de almacenes por almacenes compartidos.
- ByVaultType
-
Este parámetro ordenará la lista de almacenes por tipo de almacén.
Valores válidos:
BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT - MaxResults
-
Número máximo de elementos que se van a devolver.
Rango válido: valor mínimo de 1. Valor máximo de 1000.
- NextToken
-
El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
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,
"VaultState": "string",
"VaultType": "string"
}
],
"NextToken": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- BackupVaultList
-
Una matriz de miembros de la lista del almacén de copias de seguridad que contiene metadatos del almacén, como el nombre de recurso de Amazon (ARN), el nombre de visualización, la fecha de creación, el número de puntos de recuperación guardados y la información de cifrado si los recursos guardados en el almacén de copias de seguridad están cifrados.
Tipo: matriz de objetos BackupVaultListMember
- NextToken
-
El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
Código de estado HTTP: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
Código de estado HTTP: 400
- ResourceNotFoundException
-
No existe un recurso necesario para la acción.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
