ListScanJobs - AWS Backup

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

ListScanJobs

傳回過去 30 天內已驗證帳戶的現有掃描任務清單。

請求語法

GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI 請求參數

請求會使用下列 URI 參數。

ByAccountId

列出任務的帳戶 ID。僅傳回與特定帳戶 ID 相關聯的備份任務。

如果從 AWS Organizations 管理帳戶使用,傳遞會*傳回整個組織的所有任務。

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

ByBackupVaultName

僅傳回將存放在指定備份文件庫中的掃描任務。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。

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

ByCompleteAfter

僅傳回以 Unix 格式和國際標準時間 (UTC) 表示的日期之後完成的掃描任務。

ByCompleteBefore

僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的備份任務。

ByMalwareScanner

僅傳回指定惡意軟體掃描器的掃描任務。目前僅支援 GUARDDUTY

有效值:GUARDDUTY

ByRecoveryPointArn

僅傳回針對指定復原點執行的掃描任務。

ByResourceArn

僅傳回符合指定資源 Amazon Resource Name (ARN) 的掃描任務。

ByResourceType

依指定的還原測試計畫名稱傳回還原測試選擇。

  • EBS適用於 Amazon Elastic Block Store 的

  • EC2for Amazon Elastic Compute Cloud

  • S3for Amazon Simple Storage Service (Amazon S3)

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

有效值:EBS | EC2 | S3

ByScanResultStatus

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

  • THREATS_FOUND

  • NO_THREATS_FOUND

有效值:NO_THREATS_FOUND | THREATS_FOUND

ByState

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

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

MaxResults

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

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

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

NextToken

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

請求主體

請求沒有請求主體。

回應語法

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ScanJobs": [ { "AccountId": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "IamRoleArn": "string", "MalwareScanner": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "ScanBaseRecoveryPointArn": "string", "ScanId": "string", "ScanJobId": "string", "ScanMode": "string", "ScannerRoleArn": "string", "ScanResult": { "ScanResultStatus": "string" }, "State": "string", "StatusMessage": "string" } ] }

回應元素

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

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

NextToken

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

類型:字串

ScanJobs

結構陣列,其中包含以 JSON 格式傳回之掃描任務的中繼資料。

類型:ScanJob 物件陣列

錯誤

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

InvalidParameterValueException

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

Context

Type

HTTP 狀態碼:400

ServiceUnavailableException

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

Context

Type

HTTP 狀態碼:500

另請參閱

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