DescribeBackupJob - AWS Backup
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere 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.

DescribeBackupJob

Gibt die Details des Backup-Auftrags für die angegebene BackupJobId zurück.

Anforderungssyntax

GET /backup-jobs/backupJobId HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

backupJobId

Identifiziert eindeutig eine Anfrage AWS Backup zur Sicherung einer Ressource.

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "AccountId": "string",
   "BackupJobId": "string",
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupSizeInBytes": number,
   "BackupType": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "BytesTransferred": number,
   "ChildJobsInState": { 
      "string" : number 
   },
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "ExpectedCompletionDate": number,
   "IamRoleArn": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "MessageCategory": "string",
   "NumberOfChildJobs": number,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointLifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "StartBy": number,
   "State": "string",
   "StatusMessage": "string",
   "VaultLockState": "string",
   "VaultType": "string"
}

Antwortelemente

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

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

AccountId

Gibt die Konto-ID zurück, der der Backup-Auftrag angehört.

Typ: Zeichenfolge

Pattern: ^[0-9]{12}$

BackupJobId

Identifiziert eindeutig eine Anfrage AWS Backup zur Sicherung einer Ressource.

Typ: Zeichenfolge

BackupOptions

Stellt die Optionen dar, die als Teil eines Backup-Plans oder eines On-Demand-Backup-Auftrags angegeben wurden.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Schlüssel-Muster: ^[a-zA-Z0-9\-\_\.]{1,50}$

Wertemuster: ^[a-zA-Z0-9\-\_\.]{1,50}$

BackupSizeInBytes

Die Größe eines Backups (Wiederherstellungspunkts) in Byte.

Dieser Wert kann je nach Ressourcentyp unterschiedlich dargestellt werden, AWS Backup da Dateninformationen von anderen AWS Diensten abgerufen werden. Beispielsweise kann der zurückgegebene Wert einen Wert von aufweisen0, der vom erwarteten Wert abweichen kann.

Das erwartete Verhalten von Werten nach Ressourcentyp wird wie folgt beschrieben:

  • Bei Amazon Aurora, Amazon DocumentDB und Amazon Neptune wird dieser Wert nicht aus dem Vorgang übernommen. GetBackupJobStatus

  • Bei Amazon DynamoDB mit erweiterten Funktionen bezieht sich dieser Wert auf die Größe des Wiederherstellungspunkts (Backup).

  • Amazon EC2 und Amazon EBS zeigen die als Teil dieses Werts zurückgegebene Volumengröße (bereitgestellter Speicher) an. Amazon EBS gibt keine Informationen zur Backup-Größe zurück. Die Snapshot-Größe hat denselben Wert wie die ursprüngliche Ressource, die gesichert wurde.

  • Für Amazon EFS bezieht sich dieser Wert auf die Delta-Bytes, die während einer Sicherung übertragen wurden.

  • Amazon FSx füllt diesen Wert nicht aus dem Vorgang GetBackupJobStatus für FSx Dateisysteme auf.

  • Eine Amazon RDS-Instance wird als angezeigt0.

  • Bei laufenden VMware virtuellen Maschinen wird dieser Wert AWS Backup über einen asynchronen Workflow weitergegeben, was bedeuten kann, dass dieser angezeigte Wert die tatsächliche Backup-Größe unterrepräsentiert.

Type: Long

BackupType

Stellt den tatsächlichen Backup-Typ dar, der für einen Backup-Auftrag ausgewählt wurde. Wenn beispielsweise ein erfolgreiches Backup durch den Windows Volume Shadow Copy Service (VSS) durchgeführt wurde, gibt BackupType "WindowsVSS" zurück. Wenn BackupType leer ist, war der Backup-Typ ein reguläres Backup.

Typ: Zeichenfolge

BackupVaultArn

Ein Amazon-Ressourcenname (ARN), der einen Backup-Tresor eindeutig identifiziert, z. B. arn: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 AWS -Region, in der sie erstellt wurden, eindeutig sind.

Typ: Zeichenfolge

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

BytesTransferred

Die Größe in Byte, die zum Zeitpunkt der Abfrage des Auftragsstatus an einen Backup-Tresor übertragen wurden.

Type: Long

ChildJobsInState

Dadurch werden die Statistiken der enthaltenen untergeordneten (verschachtelten) Backup-Aufträge zurückgegeben.

Typ: Zeichenfolge auf eine lange Zuordnung

Gültige Schlüssel: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

Das Datum und die Uhrzeit, zu der ein Auftrag zum Erstellen eines Backup-Auftrags abgeschlossen wird, im Unix-Format und in der koordinierten Weltzeit (UTC). Der Wert von CompletionDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

CreatedBy

Enthält identifizierende Informationen über die Erstellung eines Backup-Auftrags, einschließlich BackupPlanArn, BackupPlanId, BackupPlanVersion und BackupRuleId des Backup-Plans, mit dem er erstellt wurde.

Typ: RecoveryPointCreator Objekt

CreationDate

Das Datum und die Uhrzeit der Erstellung eines Backup-Auftrags im Unix-Zeitformat und in der koordinierten 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

EncryptionKeyArn

Der Amazon-Ressourcenname (ARN) des KMS-Schlüssels, der zur Verschlüsselung des Backups verwendet wurde. Dies kann je nach Tresorkonfiguration ein vom Kunden AWS verwalteter Schlüssel oder ein verwalteter Schlüssel sein.

Typ: Zeichenfolge

ExpectedCompletionDate

Das Datum und die Uhrzeit, zu der ein Auftrag zum Sichern von Ressourcen abgeschlossen werden soll, im Unix-Format und in der koordinierten Weltzeit (UTC). Der Wert von ExpectedCompletionDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

IamRoleArn

Gibt den ARN der IAM-Rolle an, der zum Erstellen des Ziel-Wiederherstellungspunkts verwendet wurde; zum Beispiel arn:aws:iam::123456789012:role/S3Access.

Typ: Zeichenfolge

InitiationDate

Das Datum, an dem ein Backup-Job initiiert wurde.

Typ: Zeitstempel

IsEncrypted

Ein boolescher Wert, der angibt, ob das Backup verschlüsselt ist. Alle Backups in AWS Backup sind verschlüsselt, aber dieses Feld gibt aus Gründen der Transparenz den Verschlüsselungsstatus an.

Typ: Boolesch

IsParent

Dies gibt den booleschen Wert zurück, dass es sich bei einem Backup-Auftrag um einen übergeordneten (zusammengesetzten) Auftrag handelt.

Typ: Boolesch

MessageCategory

Die Anzahl der Jobs für die angegebene Nachrichtenkategorie.

Beispielzeichenfolgen können AccessDenied, SUCCESS, AGGREGATE_ALL oder INVALIDPARAMETERS sein. Unter Überwachung finden Sie eine Liste der akzeptierten MessageCategory Zeichenketten.

Typ: Zeichenfolge

NumberOfChildJobs

Dies gibt die Anzahl der untergeordneten (verschachtelten) Backup-Aufträge zurück.

Type: Long

ParentJobId

Dies gibt die ID des übergeordneten (zusammengesetzten) Ressourcen-Backup-Auftrags zurück.

Typ: Zeichenfolge

PercentDone

Enthält einen geschätzten Prozentsatz der Fertigstellung eines Auftrags zum Zeitpunkt der Abfrage des Auftragsstatus.

Typ: Zeichenfolge

RecoveryPointArn

Ein ARN, der einen Wiederherstellungspunkt eindeutig identifiziert, z. B. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Typ: Zeichenfolge

RecoveryPointLifecycle

Gibt den Zeitraum in Tagen an, bevor ein Erholungspunkt in einen Cold Storage übergeht oder gelöscht wird.

In den Archivspeicher übertragene Backups müssen mindestens 90 Tage lang im Archivspeicher gespeichert werden. Daher muss die Aufbewahrungseinstellung auf der Konsole um 90 Tage höher sein als die Einstellung für den Übergang zur Einstellung „Kalt nach Tagen“. Die Einstellung für den Übergang zu „kalt nach Tagen“ kann nicht geändert werden, nachdem ein Backup auf „kalt“ umgestellt 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.

Um den bestehenden Lebenszyklus und die Aufbewahrungsfristen zu entfernen und Ihre Wiederherstellungspunkte auf unbestimmte Zeit beizubehalten, geben Sie -1 für MoveToColdStorageAfterDays und an. DeleteAfterDays

Typ: Lifecycle Objekt

ResourceArn

Ein ARN bezeichnet eindeutig eine gespeicherte Ressource. Das Format eines ARN hängt vom Ressourcentyp ab.

Typ: Zeichenfolge

ResourceName

Der nicht eindeutige Name der Ressource, die zu dem angegebenen Backup gehört.

Typ: Zeichenfolge

ResourceType

Der Typ der AWS Ressource, die gesichert werden soll, z. B. ein Amazon Elastic Block Store (Amazon EBS) -Volume oder eine Amazon Relational Database Service (Amazon RDS) -Datenbank.

Typ: Zeichenfolge

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

StartBy

Gibt die Uhrzeit im Unix-Format und in der koordinierten Weltzeit (UTC) an, zu der ein Backup-Auftrag gestartet werden muss, bevor er abgebrochen wird. Der Wert wird berechnet, indem das Startfenster zur geplanten Zeit hinzugefügt wird. Wenn die geplante Zeit also 18:00 Uhr wäre und das Startfenster zwei Stunden beträgt, wäre die StartBy-Uhrzeit am angegebenen Datum 20:00 Uhr. Der Wert von StartBy ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

State

Der aktuelle Status eines Backup-Auftrags.

Typ: Zeichenfolge

Zulässige Werte: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

StatusMessage

Eine ausführliche Meldung, in der der Status des Backup-Auftrags für eine Ressource erläutert wird.

Typ: Zeichenfolge

VaultLockState

Der Sperrstatus des Backup-Tresors. Bei Tresoren mit logischem Air-Gap gibt dies an, ob der Tresor im Compliance-Modus gesperrt ist. Gültige Werte sind LOCKED und UNLOCKED.

Typ: Zeichenfolge

VaultType

Der Typ des Backup-Tresors, in dem der Recovery Point gespeichert ist. Gültige Werte gelten BACKUP_VAULT für standardmäßige Backup-Tresore und LOGICALLY_AIR_GAPPED_BACKUP_VAULT für Tresore mit logischem Air-Gap.

Typ: Zeichenfolge

Fehler

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

DependencyFailureException

Ein abhängiger AWS Dienst oder eine abhängige Ressource hat einen Fehler an den AWS Backup Dienst zurückgegeben, und die Aktion kann nicht abgeschlossen werden.

Context

Type

HTTP Status Code: 500

InvalidParameterValueException

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

Context

Type

HTTP Status Code: 400

MissingParameterValueException

Zeigt an, dass ein erforderlicher Parameter fehlt.

Context

Type

HTTP Status Code: 400

ResourceNotFoundException

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

Context

Type

HTTP Status Code: 400

ServiceUnavailableException

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

Context

Type

HTTP Status Code: 500

Weitere Informationen finden Sie unter:

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