ListBackupJobs

Gibt eine Liste der vorhandenen Backup-Aufträge für ein authentifiziertes Konto für die letzten 30 Tagen zurück. Erwägen Sie, für einen längeren Zeitraum diese Überwachungstools zu verwenden.

Anforderungssyntax

GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URIAnforderungsparameter

Die Anfrage verwendet die folgenden URI Parameter.

ByAccountId

Die Konto-ID, von der die Aufträge aufgelistet werden sollen. Gibt nur Backup-Aufträge zurück, die der angegebenen Konto-ID zugeordnet sind.

Wenn sie von einem AWS Organizations Verwaltungskonto aus verwendet wird, werden bei der Übergabe alle Jobs in der gesamten Organisation * zurückgegeben.

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

ByBackupVaultName

Gibt nur Backup-Aufträge zurück, die im angegebenen Backup-Tresor 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.

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

ByCompleteAfter

Gibt nur Sicherungsaufträge zurück, die nach einem im Unix-Format und koordinierter Weltzeit (UTC) angegebenen Datum abgeschlossen wurden.

ByCompleteBefore

Gibt nur Sicherungsaufträge zurück, die vor einem im Unix-Format und in der koordinierten Weltzeit (UTC) ausgedrückten Datum abgeschlossen wurden.

ByCreatedAfter

Gibt nur Backup-Aufträge zurück, die nach dem angegebenen Datum erstellt wurden.

ByCreatedBefore

Gibt nur Backup-Aufträge zurück, die vor dem angegebenen Datum erstellt wurden.

ByMessageCategory

Dies ist ein optionaler Parameter, der verwendet werden kann, um Jobs herauszufiltern MessageCategory , deren Wert dem von Ihnen eingegebenen Wert entspricht.

Beispielzeichenfolgen können AccessDenied, SUCCESS, AGGREGATE_ALL oder InvalidParameters sein.

Anzeige Überwachung

Der Platzhalter () gibt die Anzahl aller Nachrichtenkategorien zurück.

AGGREGATE_ALL aggregiert die Anzahl der Aufträge für alle Nachrichtenkategorien und gibt die Summe zurück.

ByParentJobId

Dies ist ein Filter, um untergeordnete (verschachtelte) Aufträge auf Grundlage der übergeordneten Auftrags-ID aufzulisten.

ByResourceArn

Gibt nur Backup-Jobs zurück, die mit der angegebenen Ressource Amazon Resource Name (ARN) übereinstimmen.

ByResourceType

Gibt nur Backup-Aufträge für die angegebenen Ressourcen zurück:

• Aurora für Amazon Aurora

• CloudFormationfür AWS CloudFormation

• DocumentDB für Amazon DocumentDB (mit MongoDB-Kompatibilität)

• DynamoDB für Amazon DynamoDB

• EBS für Amazon Elastic Block Store

• EC2 für Amazon Elastic Compute Cloud

• EFS für Amazon Elastic File System

• FSxfür Amazon FSx

• Neptune für Amazon Neptune

• RDS für Amazon Relational Database Service

• Redshift für Amazon Redshift

• S3für Amazon Simple Storage Service (Amazon S3)

• SAP HANA on Amazon EC2für SAP HANA Datenbanken auf Amazon Elastic Compute Cloud-Instances

• Storage Gatewayfür AWS Storage Gateway

• Timestream für Amazon Timestream

• VirtualMachinefür VMware virtuelle Maschinen

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

ByState

Gibt nur Backup-Aufträge zurück, die sich im angegebenen Status befinden.

Completed with issues ist ein Status, der nur in der AWS Backup -Konsole zu finden ist. Denn API dieser Status bezieht sich auf Jobs mit einem Status von COMPLETED und a MessageCategory mit einem anderen Wert alsSUCCESS; das heißt, der Status ist abgeschlossen, wird aber mit einer Statusmeldung geliefert.

Um die Anzahl der Aufträge für zu ermittelnCompleted with issues, führen Sie zwei GET Anfragen aus und subtrahieren Sie die zweite, kleinere Zahl:

GET/backup-jobs/? staat= COMPLETED

GET/Ersatzaufträge/? messageCategory= &status= SUCCESS COMPLETED

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

MaxResults

Die maximale Anzahl der zurückzugebenden Elemente.

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.

NextToken

Das nächste Element folgt auf eine unvollständige Liste der zurückgegebenen Elemente. Wenn beispielsweise eine Anforderung zur Rückgabe der MaxResults Anzahl von Elementen gestellt wird, ermöglicht Ihnen NextToken, mehr Elemente in Ihrer Liste zurückzugeben, beginnend mit der Position, auf die das nächste Token verweist.

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "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.

BackupJobs

Eine Reihe von Strukturen, die Metadaten zu Ihren Backup-Jobs enthalten, die im JSON Format zurückgegeben wurden.

Typ: Array von BackupJob-Objekten

NextToken

Das nächste Element folgt auf eine unvollständige Liste der zurückgegebenen Elemente. Wenn beispielsweise eine Anforderung zur Rückgabe der MaxResults Anzahl von Elementen gestellt wird, ermöglicht Ihnen NextToken, mehr Elemente in Ihrer Liste zurückzugeben, beginnend mit der Position, auf die das nächste Token verweist.

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

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:

• AWS -Befehlszeilenschnittstelle

• AWS SDKfür. NET

• AWS SDKfür C++

• AWS SDKfür Go v2

• AWS SDKfür Java V2

• AWS SDKfür JavaScript V3

• AWS SDKfür PHP V3

• AWS SDKfür Python

• AWS SDKfür Ruby V3