ListBackupJobSummaries - AWS Backup
AnforderungssyntaxURIAnforderungsparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere 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.

ListBackupJobSummaries

Dies ist eine Anforderung nach einer Zusammenfassung der Backup-Aufträge, die in den letzten 30 Tagen erstellt oder ausgeführt wurden. Sie können die Parameter AccountID, State,, ResourceType, MessageCategory, oder AggregationPeriod verwenden MaxResults, um Ergebnisse NextToken zu filtern.

Diese Anfrage gibt eine Zusammenfassung zurück, die Region, Account, State, ResourceType, MessageCategory, StartTime EndTime, und Anzahl der enthaltenen Jobs enthält.

Anforderungssyntax

GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

URIAnforderungsparameter

Die Anfrage verwendet die folgenden URI Parameter.

AccountId

Gibt die Anzahl der Aufträge für das angegebene Konto zurück.

Wenn die Anfrage von einem Mitgliedskonto oder einem Konto gesendet wird, das nicht Teil von AWS Organizations ist, werden Jobs innerhalb des Kontos des Anfragenden zurückgegeben.

Root-, Admin- und delegierte Administratorkonten können den Wert verwendenANY, um die Anzahl der Jobs von jedem Konto in der Organisation zurückzugeben.

AGGREGATE_ALL aggregiert die Anzahl der Aufträge aller Konten innerhalb der authentifizierten Organisation und gibt dann die Summe zurück.

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

AggregationPeriod

Der Zeitraum für die zurückgegebenen Ergebnisse.

  • ONE_DAY- Die tägliche Anzahl der Jobs der letzten 14 Tage.

  • SEVEN_DAYS- Die aggregierte Anzahl der Jobs der letzten 7 Tage.

  • FOURTEEN_DAYS- Die aggregierte Anzahl der Jobs der letzten 14 Tage.

Zulässige Werte: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

Die maximale Anzahl der zurückzugebenden Elemente.

Der Wert ist eine Ganzzahl. Der Bereich der akzeptierten Werte liegt zwischen 1 und 500.

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

MessageCategory

Dieser Parameter gibt die Anzahl der Aufträge für die angegebene Nachrichtenkategorie an.

Zu den akzeptierten Zeichenfolgen gehören beispielsweise AccessDenied, Success und InvalidParameters. Eine Liste der akzeptierten MessageCategory Zeichenketten finden Sie unter Überwachung.

Der Wert ANY 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.

NextToken

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

ResourceType

Gibt die Anzahl der Aufträge für den angegebenen Ressourcentyp zurück. Verwenden Sie Anfrage GetSupportedResourceTypes, um Zeichenfolgen für unterstützte Ressourcentypen abzurufen.

Der Wert ANY gibt die Anzahl aller Ressourcentypen zurück.

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

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.

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

State

Dieser Parameter gibt die Anzahl der Aufträge mit dem angegebenen Zustand zurück.

Der Wert ANY gibt die Anzahl aller Bundesstaaten zurück.

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

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, enthält aber eine Statusmeldung. 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/audit/? backup-job-summaries AggregationPeriod= _ &Bundesstaat= FOURTEEN DAYS COMPLETED

GET/prüfen/? backup-job-summaries AggregationPeriod= FOURTEEN _ DAYS & MessageCategory = &Bundesstaat= SUCCESS COMPLETED

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

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "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.

AggregationPeriod

Der Zeitraum für die zurückgegebenen Ergebnisse.

  • ONE_DAY- Die tägliche Anzahl der Jobs der letzten 14 Tage.

  • SEVEN_DAYS- Die aggregierte Anzahl der Jobs der letzten 7 Tage.

  • FOURTEEN_DAYS- Die aggregierte Anzahl der Jobs der letzten 14 Tage.

Typ: Zeichenfolge

BackupJobSummaries

Die zusammenfassenden Informationen.

Typ: Array von BackupJobSummary-Objekten

NextToken

Das nächste Element folgt auf eine unvollständige Liste der zurückgegebenen Ressourcen. Wenn beispielsweise eine Anforderung zur Rückgabe der MaxResults Anzahl von Ressourcen 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: