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

DescribeBackupJob

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

Anforderungssyntax

GET /backup-jobs/backupJobId HTTP/1.1

URIParameter anfordern

Die Anfrage 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",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "ExpectedCompletionDate": number,
   "IamRoleArn": "string",
   "InitiationDate": number,
   "IsParent": boolean,
   "MessageCategory": "string",
   "NumberOfChildJobs": number,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "StartBy": number,
   "State": "string",
   "StatusMessage": "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.

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 in Byte

Type: Long

BackupType

Stellt den tatsächlichen Backup-Typ dar, der für einen Backup-Auftrag ausgewählt wurde. Wenn beispielsweise eine erfolgreiche Sicherung durch den Windows Volume Shadow Copy Service (VSS) erstellt wurde, wird BackupType zurückgegeben"WindowsVSS". 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

Datum und Uhrzeit der Fertigstellung eines Jobs zur Erstellung eines Backup-Jobs im Unix-Format und in koordinierter 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

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

ExpectedCompletionDate

Datum und Uhrzeit, zu der ein Job zur Sicherung von Ressourcen voraussichtlich abgeschlossen sein wird, im Unix-Format und in koordinierter 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 die IAM Rolle an, die zum Erstellen des Ziel-Wiederherstellungspunkts ARN verwendet wurde, z. B.arn:aws:iam::123456789012:role/S3Access.

Typ: Zeichenfolge

InitiationDate

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

Typ: Zeitstempel

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

EineARN, die einen Erholungspunkt eindeutig identifiziert, z. B.arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Typ: Zeichenfolge

ResourceArn

EineARN, die eine gespeicherte Ressource eindeutig identifiziert. Das Format von ARN hängt vom Ressourcentyp ab.

Typ: Zeichenfolge

ResourceName

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

Typ: Zeichenfolge

ResourceType

Der Typ der AWS Ressource, die gesichert werden soll, z. B. ein Amazon Elastic Block Store (AmazonEBS) -Volume oder eine Amazon Relational Database Service (AmazonRDS) -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-Job 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

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.

HTTPStatuscode: 500

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: