

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [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 资源名称（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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS Python 软件开发工具包](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) 