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

ListScanJobSummaries

Dies ist eine Anforderung für eine Zusammenfassung der Scanaufträge, die in den letzten 30 Tagen erstellt wurden oder ausgeführt wurden.

Anforderungssyntax

GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1

URI-Anfrageparameter

Die Anforderung 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_DAYDie tägliche Anzahl an Aufträgen für den letzten Tag.

  • SEVEN_DAYSDie tägliche Anzahl an Aufträgen für die letzten 7 Tage.

  • FOURTEEN_DAYSDie tägliche Anzahl an Aufträgen für die letzten 14 Tage.

Zulässige Werte: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MalwareScanner

Gibt nur die Scanaufträge für den angegebenen Malware-Scanner zurück. Derzeit MalwareScanner ist das einzigeGUARDDUTY. Das Feld unterstützt aber auchANY, undAGGREGATE_ALL.

Zulässige Werte: GUARDDUTY

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.

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.

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.

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

ScanResultStatus

Gibt nur die Scanaufträge für die angegebenen Scanergebnisse zurück.

Zulässige Werte: NO_THREATS_FOUND | THREATS_FOUND

State

Gibt nur die Scanaufträge für den angegebenen Scanauftragsstatus zurück.

Zulässige Werte: CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

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

AggregationPeriod

Der Zeitraum für die zurückgegebenen Ergebnisse.

  • ONE_DAYDie tägliche Anzahl an Aufträgen für den letzten Tag.

  • SEVEN_DAYSDie tägliche Anzahl an Aufträgen für die letzten 7 Tage.

  • FOURTEEN_DAYSDie tägliche Anzahl an Aufträgen für die letzten 14 Tage.

Zulässige Werte: 'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'

Typ: Zeichenfolge

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

ScanJobSummaries

Die zusammenfassenden Informationen.

Typ: Array von ScanJobSummary-Objekten

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.

Context

Type

HTTP-Statuscode: 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: