本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
StartScanJob
開始掃描特定資源的任務。
請求語法
PUT /scan/job HTTP/1.1
Content-type: application/json
{
"BackupVaultName": "string",
"IamRoleArn": "string",
"IdempotencyToken": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanMode": "string",
"ScannerRoleArn": "string"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- BackupVaultName
-
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。
模式:
^[a-zA-Z0-9\-\_]{2,50}$類型:字串
必要:是
- IamRoleArn
-
指定用來建立目標復原點的 IAM 角色 ARN;例如
arn:aws:iam::123456789012:role/S3Access。類型:字串
必要:是
- IdempotencyToken
-
客戶所選擇的字串,可用來區分在其他方面相同的
StartScanJob呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息,但未執行任何動作。類型:字串
必要:否
- MalwareScanner
-
指定掃描任務期間使用的惡意軟體掃描器。目前僅支援
GUARDDUTY。類型:字串
有效值:
GUARDDUTY必要:是
- RecoveryPointArn
-
唯一識別復原點的 Amazon Resource Name (ARN)。這是完整掃描的目標復原點。如果您正在執行增量掃描,這將是您的基本復原點選擇之後建立的復原點。
類型:字串
必要:是
- ScanBaseRecoveryPointArn
-
唯一識別用於增量掃描之基本復原點的 ARN。
類型:字串
必要:否
- ScanMode
-
指定掃描任務使用的掃描類型。
包括:
-
FULL_SCAN會掃描備份中的整個資料歷程。 -
INCREMENTAL_SCAN會掃描目標復原點和基本復原點 ARN 之間的資料差異。
類型:字串
有效值:
FULL_SCAN | INCREMENTAL_SCAN必要:是
-
- ScannerRoleArn
-
指定 IAM 掃描器角色 ARN。
類型:字串
必要:是
回應語法
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 201 回應。
服務會傳回下列 JSON 格式的資料。
- CreationDate
-
建立備份任務時的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。
CreationDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- ScanJobId
-
唯一識別 AWS Backup 對 備份資源的請求。
類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
- Context
- Type
HTTP 狀態碼:400
- InvalidRequestException
-
表示請求的輸入出現問題。例如,參數的類型錯誤。
- Context
- Type
HTTP 狀態碼:400
- LimitExceededException
-
請求已超過限制;例如,請求中允許的最大項目數量。
- Context
- Type
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
- Context
- Type
HTTP 狀態碼:400
- ResourceNotFoundException
-
動作所需的資源不存在。
- Context
- Type
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
- Context
- Type
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: