DescribeBackupVault - AWS Backup
AnforderungssyntaxURIParameter anfordernAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeBackupVault

Gibt Metadaten zu einem durch seinen Namen angegebenen Backup-Tresor zurück.

Anforderungssyntax

GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1

URIParameter anfordern

Die Anfrage verwendet die folgenden URI Parameter.

BackupVaultAccountId

Die Konto-ID des angegebenen Backup-Tresors.

backupVaultName

Der Name eines logischen Containers, in dem die Sicherungen gespeichert werden. Backup-Tresore werden durch Namen identifiziert, die für das Konto, mit dem sie erstellt wurden, und die AWS -Region, in der sie erstellt wurden, eindeutig sind.

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

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"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

BackupVaultArn

Ein Amazon-Ressourcenname (ARN), der einen Backup-Tresor eindeutig identifiziert; zum Beispielarn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Typ: Zeichenfolge

BackupVaultName

Der Name eines logischen Containers, in dem die Sicherungen gespeichert werden. Backup-Tresore werden durch Namen identifiziert, die für das Konto, mit dem sie erstellt wurden, und die -Region, in der sie erstellt wurden, eindeutig sind.

Typ: Zeichenfolge

CreationDate

Datum und Uhrzeit der Erstellung eines Backup-Tresors im Unix-Format und in koordinierter Weltzeit (UTC). Der Wert von CreationDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

CreatorRequestId

Eine eindeutige Zeichenfolge, die die Anfrage angibt und die Wiederholung fehlgeschlagener Anforderungen ermöglicht, ohne dass das Risiko besteht, dass die Operation zweimal ausgeführt wird. Dieser Parameter ist optional. Wenn dieser Parameter verwendet wird, muss er 1 bis 50 alphanumerische Zeichen oder „-_“ enthalten. Zeichen.

Typ: Zeichenfolge

EncryptionKeyArn

Die serverseitige Verschlüsselung zum Schutz Ihrer Backups, z. B. arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Typ: Zeichenfolge

LockDate

Datum und Uhrzeit, zu denen die AWS Backup Vault Lock-Konfiguration nicht geändert oder gelöscht werden kann.

Wenn Sie Vault Lock auf Ihren Tresor angewendet haben, ohne ein Sperrdatum anzugeben, können Sie Ihre Vault Lock-Einstellungen jederzeit ändern oder Vault Lock vollständig aus dem Tresor löschen.

Dieser Wert ist im Unix-Format, Coordinated Universal Time (UTC), und ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

Locked

Ein boolescher Wert, der angibt, ob AWS Backup Vault Lock derzeit den Backup-Tresor schützt. Truebedeutet, dass Vault Lock dazu führt, dass Lösch- oder Aktualisierungsvorgänge an den im Tresor gespeicherten Wiederherstellungspunkten fehlschlagen.

Typ: Boolesch

MaxRetentionDays

Die AWS Backup Vault Lock-Einstellung, die den maximalen Aufbewahrungszeitraum festlegt, für den der Tresor seine Wiederherstellungspunkte aufbewahrt. Wenn dieser Parameter nicht angegeben wird, erzwingt Vault Lock keine maximale Aufbewahrungsdauer für die Wiederherstellungspunkte im Tresor (und erlaubt somit eine unbegrenzte Speicherung).

Wenn angegeben, muss jeder Backup- oder Kopierauftrag in den Tresor über eine Lebenszyklusrichtlinie mit einer Aufbewahrungsdauer verfügen, die der maximalen Aufbewahrungsdauer entspricht oder kürzer ist. Wenn die Aufbewahrungsdauer des Auftrags länger als die maximale Aufbewahrungsdauer ist, schlägt der Tresor den Backup- oder Kopierauftrag fehl, und Sie sollten entweder Ihre Lebenszyklus-Einstellungen ändern oder einen anderen Tresor verwenden. Wiederherstellungspunkte, die bereits vor der Tresorsperre im Tresor gespeichert wurden, sind nicht betroffen.

Type: Long

MinRetentionDays

Die AWS Backup Vault Lock-Einstellung, die den Mindestaufbewahrungszeitraum festlegt, für den der Tresor seine Wiederherstellungspunkte aufbewahrt. Wenn dieser Parameter nicht angegeben wird, erzwingt Vault Lock keine Mindestaufbewahrungsdauer.

Wenn angegeben, muss jeder Backup- oder Kopierauftrag in den Tresor über eine Lebenszyklusrichtlinie mit einer Aufbewahrungsdauer verfügen, die der minimalen Aufbewahrungsdauer entspricht oder länger ist. Wenn die Aufbewahrungsfrist des Auftrags länger als die maximale Aufbewahrungsdauer ist, kann der Tresor den Backup- oder Kopierauftrag nicht ausführen und Sie sollten entweder Ihre Lebenszyklus-Einstellungen ändern oder einen anderen Tresor verwenden. Wiederherstellungspunkte, die bereits vor der Tresorsperre im Tresor gespeichert wurden, sind nicht betroffen.

Type: Long

NumberOfRecoveryPoints

Die Anzahl der Wiederherstellungspunkte, die in einem Backup-Tresor gespeichert sind.

Type: Long

VaultState

Der aktuelle Status des Tresors. ->

Typ: Zeichenfolge

Zulässige Werte: CREATING | AVAILABLE | FAILED

VaultType

Der beschriebene Tresortyp.

Typ: Zeichenfolge

Zulässige Werte: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InvalidParameterValueException

Zeigt an, dass etwas mit dem Wert eines Parameters nicht stimmt. Beispielsweise liegt der Wert außerhalb des zulässigen Bereichs.

HTTPStatuscode: 400

MissingParameterValueException

Zeigt an, dass ein erforderlicher Parameter fehlt.

HTTPStatuscode: 400

ResourceNotFoundException

Eine Ressource, die für die Aktion erforderlich ist, ist nicht vorhanden.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anforderung ist aufgrund eines temporären Fehlers des Servers fehlgeschlagen.

HTTPStatuscode: 500

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: