

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

# DescribeScanJob
<a name="API_DescribeScanJob"></a>

傳回指定 ScanJobID 的掃描任務詳細資訊。

## 請求語法
<a name="API_DescribeScanJob_RequestSyntax"></a>

```
GET /scan/jobs/ScanJobId HTTP/1.1
```

## URI 請求參數
<a name="API_DescribeScanJob_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **   <a name="Backup-DescribeScanJob-request-uri-ScanJobId"></a>
唯一識別 AWS Backup 對 掃描資源的請求。  
必要：是

## 請求主體
<a name="API_DescribeScanJob_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_DescribeScanJob_ResponseSyntax"></a>

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

## 回應元素
<a name="API_DescribeScanJob_ResponseElements"></a>

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

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

 ** [AccountId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-AccountId"></a>
傳回擁有掃描任務的帳戶 ID。  
模式：`^[0-9]{12}$`  
類型：字串

 ** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultArn"></a>
可唯一識別備份保存庫的 Amazon Resource Name (ARN)；例如， `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`  
類型：字串

 ** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
模式：`^[a-zA-Z0-9\-\_\.]{2,50}$`  
類型：字串

 ** [CompletionDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CompletionDate"></a>
備份索引完成建立的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatedBy](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreatedBy"></a>
包含有關建立掃描任務的識別資訊，包括啟動掃描的備份計畫和規則。  
類型：[ScanJobCreator](API_ScanJobCreator.md) 物件

 ** [CreationDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreationDate"></a>
備份索引完成建立的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IamRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-IamRoleArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

 ** [MalwareScanner](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-MalwareScanner"></a>
用於對應掃描任務的掃描引擎。目前僅支援 `GUARDUTY`。  
類型：字串  
有效值:`GUARDDUTY` 

 ** [RecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-RecoveryPointArn"></a>
可唯一識別目標復原點以進行掃描的 ARN；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串

 ** [ResourceArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceArn"></a>
唯一識別對應復原點 ARN 來源資源的 ARN。  
類型：字串

 ** [ResourceName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceName"></a>
屬於指定備份之資源的非唯一名稱。  
類型：字串

 ** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceType"></a>
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
類型：字串  
有效值:`EBS | EC2 | S3` 

 ** [ScanBaseRecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanBaseRecoveryPointArn"></a>
唯一識別基本復原點以進行掃描的 ARN。只有在進行增量掃描任務時，才會填入此欄位。  
類型：字串

 ** [ScanId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanId"></a>
Amazon GuardDuty 為對應的掃描任務 ID 請求產生的掃描 ID AWS Backup。  
類型：字串

 ** [ScanJobId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanJobId"></a>
唯一識別請求的掃描任務 ID AWS Backup。  
類型：字串

 ** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanMode"></a>
指定用於掃描任務的掃描類型。  
類型：字串  
有效值:`FULL_SCAN | INCREMENTAL_SCAN` 

 ** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScannerRoleArn"></a>
指定掃描任務用於 的掃描器 IAM 角色 ARN。  
類型：字串

 ** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanResult"></a>
 包含掃描任務`ScanResultsStatus`的 ，以及傳回已完成任務`NO_THREATS_FOUND`的 `THREATS_FOUND`或 。  
類型：[ScanResultInfo](API_ScanResultInfo.md) 物件

 ** [State](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-State"></a>
掃描任務的目前狀態。  
類型：字串  
有效值:`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING` 

 ** [StatusMessage](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-StatusMessage"></a>
說明備份資源任務狀態的詳細訊息。  
類型：字串

## 錯誤
<a name="API_DescribeScanJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_DescribeScanJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeScanJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeScanJob) 