

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

# GetSearchJob
<a name="API_BKS_GetSearchJob"></a>

此操作會擷取搜尋任務的中繼資料，包括其進度。

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

```
GET /search-jobs/SearchJobIdentifier HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_RequestSyntax) **   <a name="Backup-BKS_GetSearchJob-request-uri-SearchJobIdentifier"></a>
指定搜尋任務所需的唯一字串。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
Content-type: application/json

{
   "CompletionTime": number,
   "CreationTime": number,
   "CurrentSearchProgress": { 
      "ItemsMatchedCount": number,
      "ItemsScannedCount": number,
      "RecoveryPointsScannedCount": number
   },
   "EncryptionKeyArn": "string",
   "ItemFilters": { 
      "EBSItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "FilePaths": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "LastModificationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ]
         }
      ],
      "S3ItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "ETags": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "ObjectKeys": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "VersionIds": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ]
         }
      ]
   },
   "Name": "string",
   "SearchJobArn": "string",
   "SearchJobIdentifier": "string",
   "SearchScope": { 
      "BackupResourceArns": [ "string" ],
      "BackupResourceCreationTime": { 
         "CreatedAfter": number,
         "CreatedBefore": number
      },
      "BackupResourceTags": { 
         "string" : "string" 
      },
      "BackupResourceTypes": [ "string" ],
      "SourceResourceArns": [ "string" ]
   },
   "SearchScopeSummary": { 
      "TotalItemsToScanCount": number,
      "TotalRecoveryPointsToScanCount": number
   },
   "Status": "string",
   "StatusMessage": "string"
}
```

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

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

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

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

 ** [CreationTime](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-CreationTime"></a>
建立搜尋任務的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CompletionTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CurrentSearchProgress](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-CurrentSearchProgress"></a>
傳回代表 BackupsScannedCount、ItemsScanned 和 ItemsMatched 的數字。  
類型：[CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) 物件

 ** [EncryptionKeyArn](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-EncryptionKeyArn"></a>
指定搜尋任務的加密金鑰。  
範例：`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
類型：字串

 ** [ItemFilters](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-ItemFilters"></a>
項目篩選條件代表建立搜尋時指定的所有輸入項目屬性。  
類型：[ItemFilters](API_BKS_ItemFilters.md) 物件

 ** [Name](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-Name"></a>
傳回指定搜尋任務的名稱。  
類型：字串

 ** [SearchJobArn](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchJobArn"></a>
識別指定搜尋任務之 Amazon Resource Name (ARN) 的唯一字串。  
類型：字串

 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchJobIdentifier"></a>
識別指定搜尋任務的唯一字串。  
類型：字串

 ** [SearchScope](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchScope"></a>
搜尋範圍是輸入至搜尋的所有備份屬性。  
類型：[SearchScope](API_BKS_SearchScope.md) 物件

 ** [SearchScopeSummary](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchScopeSummary"></a>
傳回指定搜尋任務範圍的摘要，包括：  
+ TotalBackupsToScanCount，搜尋傳回的復原點數目。
+ TotalItemsToScanCount，搜尋傳回的項目數。
類型：[SearchScopeSummary](API_BKS_SearchScopeSummary.md) 物件

 ** [Status](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-Status"></a>
指定搜尋任務的目前狀態。  
搜尋任務可能有下列其中一種狀態：`RUNNING`；`COMPLETED`；`STOPPED`；`FAILED`；`TIMED_OUT`；； 或 `EXPIRED` 。  
類型：字串  
有效值:`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED` 

 ** [StatusMessage](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-StatusMessage"></a>
對於狀態為 的搜尋任務，`ERRORED`或狀態為有問題`COMPLETED`的任務，將會傳回狀態訊息。  
例如，訊息可能表示因為許可問題而無法掃描包含復原點的搜尋。  
類型：字串

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

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

 ** AccessDeniedException **   
您沒有足夠存取權可執行此動作。    
 ** message **   
使用者沒有足夠的存取權來執行此動作。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。重試您的請求。    
 ** message **   
處理請求時發生非預期的錯誤。  
 ** retryAfterSeconds **   
在秒數後重試呼叫。
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到此請求的資源。  
確認資源資訊，例如 ARN 或類型正確且存在，然後重試請求。    
 ** message **   
請求會參考不存在的資源。  
 ** resourceId **   
受影響資源的假設識別符。  
 ** resourceType **   
受影響資源的假設類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
由於請求調節，因此請求遭到拒絕。    
 ** message **   
由於請求調節，請求失敗。  
 ** quotaCode **   
這是具有配額之原始服務的唯一程式碼。  
 ** retryAfterSeconds **   
在秒數後重試呼叫。  
 ** serviceCode **   
這是原始服務的唯一程式碼。
HTTP 狀態碼：429

 ** ValidationException **   
輸入無法滿足服務指定的限制條件。    
 ** message **   
輸入無法滿足 Amazon 服務指定的限制條件。
HTTP 狀態碼：400

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

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