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.
StartBackupJob
Startet einen On-Demand-Backup-Auftrag für die angegebene Ressource
Anforderungssyntax
PUT /backup-jobs HTTP/1.1
Content-type: application/json
{
"BackupOptions": {
"string
" : "string
"
},
"BackupVaultName": "string
",
"CompleteWindowMinutes": number
,
"IamRoleArn": "string
",
"IdempotencyToken": "string
",
"Lifecycle": {
"DeleteAfterDays": number
,
"MoveToColdStorageAfterDays": number
,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string
" : "string
"
},
"ResourceArn": "string
",
"StartWindowMinutes": number
}
URIParameter anfordern
Die Anfrage verwendet keine URI Parameter.
Anforderungstext
Die Anfrage akzeptiert die folgenden Daten im JSON Format.
- BackupOptions
-
Die Backup-Option für eine ausgewählte Ressource. Diese Option ist nur für Sicherungsaufträge des Windows Volume Shadow Copy Service (VSS) verfügbar.
Gültige Werte: Auf setzen,
"WindowsVSS":"enabled"
um dieWindowsVSS
Sicherungsoption zu aktivieren und ein VSS Windows-Backup zu erstellen. Stellen Sie sie auf"WindowsVSS""disabled"
ein, um ein reguläres Backup zu erstellen. Die OptionWindowsVSS
ist standardmäßig aktiviert.Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Muster:
^[a-zA-Z0-9\-\_\.]{1,50}$
Wertemuster:
^[a-zA-Z0-9\-\_\.]{1,50}$
Erforderlich: Nein
- 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.
Typ: Zeichenfolge
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
Erforderlich: Ja
- CompleteWindowMinutes
-
Ein Wert in Minuten, in dem ein erfolgreich gestartetes Backup abgeschlossen werden muss, andernfalls bricht AWS Backup den Auftrag ab. Dieser Wert ist optional. Dieser Wert beginnt mit dem Countdown ab dem Zeitpunkt, zu dem das Backup geplant wurde. Es wird keine zusätzliche Zeit für
StartWindowMinutes
hinzugefügt, oder wenn das Backup später als geplant gestartet wurde.Wie
StartWindowMinutes
hat dieser Parameter hat einen maximalen Wert von 100 Jahren (52.560.000 Minuten).Type: Long
Erforderlich: Nein
- IamRoleArn
-
Gibt die IAM Rolle an, die zum Erstellen des Ziel-Wiederherstellungspunkts ARN verwendet wurde; zum Beispiel
arn:aws:iam::123456789012:role/S3Access
.Typ: Zeichenfolge
Erforderlich: Ja
- IdempotencyToken
-
Eine vom Kunden gewählte Zeichenfolge, mit der Sie zwischen ansonsten identischen Aufrufen an
StartBackupJob
unterscheiden können. Der erneute Versuch einer erfolgreichen Anforderung mit demselben Idempotenz-Token führt zu einer Erfolgsmeldung, ohne dass Maßnahmen ergriffen werden.Typ: Zeichenfolge
Erforderlich: Nein
- Lifecycle
-
Der Lebenszyklus definiert, wann eine geschützte Ressource in einen Cold Storage übertragen wird und wann sie abläuft. AWS Backup überträgt Backups automatisch und läuft entsprechend dem von Ihnen definierten Lebenszyklus ab.
In den Cold Storage übertragene Sicherungen müssen mindestens 90 Tage lang im Cold Storage gespeichert werden. Daher muss die Einstellung für „Ablauf nach Tagen“ 90 Tage größer als die Einstellung für „Übertragung in Archivspeicher nach Tagen“ sein. Die Einstellung „Übertragung in Archivspeicher nach Tagen“ kann nicht geändert werden, sobald eine Sicherung in den Archivspeicher übertragen wurde.
Ressourcentypen, die auf Cold Storage umgestellt werden können, sind in der Tabelle Verfügbarkeit von Funktionen nach Ressourcen aufgeführt. AWS Backup ignoriert diesen Ausdruck für andere Ressourcentypen.
Der Höchstwert für diesen Parameter ist 100 Jahre (36.500 Tage).
Typ: Lifecycle Objekt
Erforderlich: Nein
- RecoveryPointTags
-
Die Tags, die den Ressourcen zugewiesen werden sollen.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Erforderlich: Nein
- ResourceArn
-
Ein Amazon-Ressourcenname (ARN), der eine Ressource eindeutig identifiziert. Das Format von ARN hängt vom Ressourcentyp ab.
Typ: Zeichenfolge
Erforderlich: Ja
- StartWindowMinutes
-
Ein Wert in Minuten, nachdem ein Backup geplant ist, bevor ein Auftrag storniert wird, wenn er nicht erfolgreich gestartet werden kann. Dieser Wert ist optional und der Standardwert beträgt 8 Stunden. Wenn dieser Wert enthalten ist, muss er mindestens 60 Minuten betragen, um Fehler zu vermeiden.
Dieser Parameter hat einen maximalen Wert von 100 Jahren (52.560.000 Minuten).
Während des Startfensters bleibt der Status des Backup-Auftrags so lange im
CREATED
-Status, bis er erfolgreich gestartet wurde oder bis die Startfensterzeit abgelaufen ist. Tritt innerhalb des Startfensters ein Fehler auf, sodass der Job erneut versucht werden kann, AWS Backup wird automatisch mindestens alle 10 Minuten erneut versucht, den Job zu starten, bis die Sicherung erfolgreich gestartet wird (der Jobstatus ändert sich aufRUNNING
) oder bis sich der Jobstatus auf ändertEXPIRED
(was voraussichtlich nach Ablauf der Startzeit der Fall sein wird). AWS BackupType: Long
Erforderlich: Nein
Antwortsyntax
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "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.
- BackupJobId
-
Identifiziert eindeutig eine Anfrage AWS Backup zur Sicherung einer Ressource.
Typ: Zeichenfolge
- CreationDate
-
Datum und Uhrzeit der Erstellung eines Backup-Jobs 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
- IsParent
-
Dies ist ein zurückgegebener boolescher Wert, der angibt, dass es sich um einen übergeordneten (zusammengesetzten) Backup-Auftrag handelt.
Typ: Boolesch
- RecoveryPointArn
-
Hinweis: Dieses Feld wird nur für Amazon EFS - und Advanced DynamoDB-Ressourcen zurückgegeben.
EinARN, das einen Wiederherstellungspunkt eindeutig identifiziert; zum Beispiel.
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
Typ: Zeichenfolge
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
- InvalidRequestException
-
Zeigt an, dass etwas mit der Eingabe für die Anforderung nicht stimmt. Beispielsweise ist ein Parameter vom falschen Typ.
HTTPStatuscode: 400
- LimitExceededException
-
Ein Limit in der Anforderung wurde überschritten, z. B. die maximale Anzahl von Elementen, die in einer Anforderung zulässig sind.
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: