ListScanJobSummaries - AWS Backup

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ListScanJobSummaries

這是對最近 30 天內建立或執行的掃描任務摘要的請求。

請求語法

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 請求參數

請求會使用下列 URI 參數。

AccountId

傳回指定帳戶的任務計數。

如果請求是從成員帳戶或不屬於 AWS Organizations 的帳戶傳送,則會傳回請求者帳戶中的任務。

根帳戶、管理員帳戶和委派管理員帳戶可以使用 值ANY,從組織中的每個帳戶傳回任務計數。

AGGREGATE_ALL 彙總已驗證組織內所有帳戶的任務計數,然後傳回總和。

模式:^[0-9]{12}$

AggregationPeriod

傳回結果的期間。

  • ONE_DAY前 1 天的每日任務計數。

  • SEVEN_DAYS過去 7 天的每日任務計數。

  • FOURTEEN_DAYS過去 14 天的每日任務計數。

有效值:ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MalwareScanner

僅傳回指定惡意軟體掃描器的掃描任務。目前唯一的 MalwareScanner 是 GUARDDUTY。但 欄位也支援 ANY、 和 AGGREGATE_ALL

有效值:GUARDDUTY

MaxResults

所要傳回的項目數量上限。

值是整數。可接受值的範圍是從 1 到 500。

有效範圍:最小值為 1。最大值為 1000。

NextToken

傳回項目之部分列表後的下一個項目。例如,如果請求傳回 MaxResults 個數量的項目,則 NextToken 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

ResourceType

傳回指定資源類型的任務計數。使用請求 GetSupportedResourceTypes 取得支援資源類型的字串。

此值ANY會傳回所有資源類型的計數。

AGGREGATE_ALL 彙總所有資源類型的任務計數,並傳回總和。

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

ScanResultStatus

僅傳回指定掃描結果的掃描任務。

有效值:NO_THREATS_FOUND | THREATS_FOUND

State

僅傳回指定掃描任務狀態的掃描任務。

有效值:CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY

請求主體

請求沒有請求主體。

回應語法

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" } ] }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

AggregationPeriod

傳回結果的期間。

  • ONE_DAY前 1 天的每日任務計數。

  • SEVEN_DAYS過去 7 天的每日任務計數。

  • FOURTEEN_DAYS過去 14 天的每日任務計數。

有效值: 'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'

類型:字串

NextToken

傳回項目之部分列表後的下一個項目。例如,如果請求傳回 MaxResults 個數量的項目,則 NextToken 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

類型:字串

ScanJobSummaries

摘要資訊。

類型:ScanJobSummary 物件陣列

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InvalidParameterValueException

表示參數的值出現問題。例如,值超出範圍。

Context

Type

HTTP 狀態碼:400

ServiceUnavailableException

由於伺服器發生臨時故障,請求失敗。

Context

Type

HTTP 狀態碼:500

另請參閱

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: