本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeScanJob
傳回指定 ScanJobID 的掃描任務詳細資訊。
請求語法
GET /scan/jobs/ScanJobId HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- ScanJobId
-
唯一識別 AWS Backup 對 掃描資源的請求。
必要:是
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"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 格式的資料。
- AccountId
-
傳回擁有掃描任務的帳戶 ID。
模式:
^[0-9]{12}$類型:字串
- BackupVaultArn
-
可唯一識別備份保存庫的 Amazon Resource Name (ARN);例如,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault類型:字串
- BackupVaultName
-
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。
模式:
^[a-zA-Z0-9\-\_\.]{2,50}$類型:字串
- CompletionDate
-
備份索引完成建立的日期和時間,採用 Unix 格式和國際標準時間 (UTC)。
CompletionDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- CreatedBy
-
包含有關建立掃描任務的識別資訊,包括啟動掃描的備份計畫和規則。
類型:ScanJobCreator 物件
- CreationDate
-
備份索引完成建立的日期和時間,採用 Unix 格式和國際標準時間 (UTC)。
CreationDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- IamRoleArn
-
可唯一識別備份文件庫的 Amazon Resource Name (ARN),例如
arn:aws:iam::123456789012:role/S3Access。類型:字串
- MalwareScanner
-
用於對應掃描任務的掃描引擎。目前僅支援
GUARDUTY。類型:字串
有效值:
GUARDDUTY - RecoveryPointArn
-
可唯一識別目標復原點以進行掃描的 ARN;例如
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45。類型:字串
- ResourceArn
-
唯一識別對應復原點 ARN 來源資源的 ARN。
類型:字串
- ResourceName
-
屬於指定備份之資源的非唯一名稱。
類型:字串
- ResourceType
-
要備份 AWS 的資源類型;例如,Amazon Elastic Block Store (Amazon EBS) 磁碟區。
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$類型:字串
有效值:
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
可唯一識別基本復原點以進行掃描的 ARN。只有在進行增量掃描任務時,才會填入此欄位。
類型:字串
- ScanId
-
Amazon GuardDuty 針對來自 的對應掃描任務 ID 請求所產生的掃描 ID AWS Backup。
類型:字串
- ScanJobId
-
唯一識別請求的掃描任務 ID AWS Backup。
類型:字串
- ScanMode
-
指定用於掃描任務的掃描類型。
類型:字串
有效值:
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
指定掃描任務用於 的掃描器 IAM 角色 ARN。
類型:字串
- ScanResult
-
包含掃描任務
ScanResultsStatus的 ,以及傳回已完成任務NO_THREATS_FOUND的THREATS_FOUND或 。類型:ScanResultInfo 物件
- State
-
掃描任務的目前狀態。
類型:字串
有效值:
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
說明備份資源任務狀態的詳細訊息。
類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
- Context
- Type
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
- Context
- Type
HTTP 狀態碼:400
- ResourceNotFoundException
-
動作所需的資源不存在。
- Context
- Type
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
- Context
- Type
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: