

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

# DescribeRestoreJob
<a name="API_DescribeRestoreJob"></a>

傳回與任務 ID 所指定還原任務相關聯的中繼資料。

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

```
GET /restore-jobs/restoreJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **   <a name="Backup-DescribeRestoreJob-request-uri-RestoreJobId"></a>
可唯一識別還原復原點的任務。  
必要：是

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

請求沒有請求主體。

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

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

{
   "AccountId": "string",
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "RestoreTestingPlanArn": "string"
   },
   "CreatedResourceArn": "string",
   "CreationDate": number,
   "DeletionStatus": "string",
   "DeletionStatusMessage": "string",
   "ExpectedCompletionTimeMinutes": number,
   "IamRoleArn": "string",
   "IsParent": boolean,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointCreationDate": number,
   "ResourceType": "string",
   "RestoreJobId": "string",
   "SourceResourceArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

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

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

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

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

 ** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupSizeInBytes"></a>
所還原資源的大小，以位元組為單位。  
類型：Long

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
備份文件庫的 Amazon Resource Name (ARN)，其中包含要還原的復原點。這有助於識別保存庫存取政策和許可。  
類型：字串

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

 ** [CreatedBy](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedBy"></a>
包含有關建立還原任務的識別資訊。  
類型：[RestoreJobCreator](API_RestoreJobCreator.md) 物件

 ** [CreatedResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedResourceArn"></a>
還原任務所建立資源的 Amazon Resource Name (ARN)。  
ARN 的格式取決於備份資源的資源類型。  
類型：字串

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

 ** [DeletionStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatus"></a>
還原測試產生的資料狀態。  
類型：字串  
有效值:`DELETING | FAILED | SUCCESSFUL` 

 ** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatusMessage"></a>
此會說明還原任務刪除狀態。  
類型：字串

 ** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ExpectedCompletionTimeMinutes"></a>
還原復原點之任務預計所需的時間 (分鐘)。  
類型：Long

 ** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

 ** [IsParent](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IsParent"></a>
這是布林值，指出還原任務是否為父系 （複合） 還原任務。  
類型：布林值

 ** [ParentJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ParentJobId"></a>
這是所選還原任務之父系還原任務的唯一識別符。  
類型：字串

 ** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-PercentDone"></a>
包含查詢任務狀態時，任務的預估完成百分比。  
類型：字串

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

 ** [RecoveryPointCreationDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointCreationDate"></a>
指定還原任務建立復原點的日期。  
類型：Timestamp

 ** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ResourceType"></a>
傳回與依資源類型列出之還原任務相關聯的中繼資料。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [RestoreJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RestoreJobId"></a>
可唯一識別還原復原點的任務。  
類型：字串

 ** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-SourceResourceArn"></a>
備份之原始資源的 Amazon Resource Name (ARN)。這會提供有關正在還原之資源的內容。  
類型：字串

 ** [Status](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-Status"></a>
指定由 啟動 AWS Backup 以還原復原點之任務狀態的狀態碼。  
類型：字串  
有效值:`PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [StatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-StatusMessage"></a>
顯示還原復原點任務狀態的訊息。  
類型：字串

 ** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatus"></a>
指定還原任務上執行的驗證狀態。  
類型：字串  
有效值:`FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING` 

 ** [ValidationStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatusMessage"></a>
狀態訊息。  
類型：字串

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

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

 ** DependencyFailureException **   
相依 AWS 服務或資源傳回錯誤給 AWS Backup 服務，且無法完成動作。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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