

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

# DescribeRecoveryPoint
<a name="API_DescribeRecoveryPoint"></a>

傳回與復原點相關聯的中繼資料，包括 ID、狀態、加密和生命週期。

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-BackupVaultAccountId"></a>
指定備份保存庫的帳戶 ID。  
模式：`^[0-9]{12}$`

 ** [backupVaultName](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [recoveryPointArn](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-RecoveryPointArn"></a>
可唯一識別復原點的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "CompletionDate": number,
   "CompositeMemberIdentifier": "string",
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "IamRoleArn": "string",
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "LastRestoreTime": number,
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ParentRecoveryPointArn": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanResults": [ 
      { 
         "Findings": [ "string" ],
         "LastScanTimestamp": number,
         "MalwareScanner": "string",
         "ScanJobState": "string"
      }
   ],
   "SourceBackupVaultArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "StorageClass": "string",
   "VaultType": "string"
}
```

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

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

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

 ** [BackupSizeInBytes](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupSizeInBytes"></a>
備份的大小，以位元組為單位。  
類型：Long

 ** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 ARN，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

 ** [BackupVaultName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [CalculatedLifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CalculatedLifecycle"></a>
包含 `DeleteAt` 和 `MoveToColdStorageAt` 時間戳記的 `CalculatedLifecycle` 物件。  
類型：[CalculatedLifecycle](API_CalculatedLifecycle.md) 物件

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

 ** [CompositeMemberIdentifier](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompositeMemberIdentifier"></a>
複合群組中資源的識別符，例如屬於複合 （父） 堆疊的巢狀 （子） 復原點。ID 會從堆疊中的[邏輯 ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) 傳輸。  
類型：字串

 ** [CreatedBy](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CreatedBy"></a>
含有建立復原點的相關識別資訊，包括用於建立復原點之備份計畫的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
類型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 物件

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

 ** [EncryptionKeyArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyArn"></a>
用來保護備份的伺服器端加密金鑰，例如 `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
類型：字串

 ** [EncryptionKeyType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyType"></a>
用於復原點的加密金鑰類型。有效值為客戶受管金鑰的 CUSTOMER\$1MANAGED\$1KMS\$1KEY 或 AWS擁有金鑰的 AWS\$1OWNED\$1KMS\$1KEY。  
類型：字串  
有效值:`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

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

 ** [IndexStatus](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IndexStatus"></a>
這是與指定復原點相關聯之備份索引的目前狀態。  
狀態為： `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
索引狀態為 的復原點`ACTIVE`可以包含在搜尋中。  
類型：字串  
有效值:`PENDING | ACTIVE | FAILED | DELETING` 

 ** [IndexStatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IndexStatusMessage"></a>
詳細的訊息形式的字串，說明與復原點相關聯的備份索引狀態。  
類型：字串

 ** [InitiationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-InitiationDate"></a>
建立此復原點的備份任務啟動的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。  
類型：Timestamp

 ** [IsEncrypted](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsEncrypted"></a>
傳回的布林值，若指定的復原點已加密，則為 `TRUE`，若復原點未加密，則為 `FALSE`。  
類型：布林值

 ** [IsParent](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsParent"></a>
這會傳回復原點為父項 (複合) 任務的布林值。  
類型：布林值

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

 ** [Lifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Lifecycle"></a>
生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 會根據您定義的生命週期自動 AWS Backup 轉換和過期備份。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天。因此，「保留期」設定必須比「轉移至冷儲存前所需天數」設定長 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
類型：[Lifecycle](API_Lifecycle.md) 物件

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

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

 ** [ResourceArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceArn"></a>
可唯一識別已儲存資源的 ARN。ARN 的格式取決於資源類型。  
類型：字串

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

 ** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceType"></a>
儲存為復原點 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
包含針對復原點的最新掃描結果，目前包括 `MalwareScanner`、`Findings`、 `ScanJobState`和 `LastScanTimestamp`   
類型：[ScanResult](API_ScanResult.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 5。

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
可唯一識別原始備份資源之來源保存庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。如果復原還原至相同的 AWS 帳戶或區域，則此值將為 `null`。  
類型：字串

 ** [Status](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Status"></a>
指定復原點狀態的狀態碼。如需詳細資訊，請參閱《 * AWS Backup 開發人員指南*》中的[復原點狀態](https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus)。  
+  `CREATING` 狀態表示已為資源啟動 AWS Backup 任務。備份程序已啟動，並正在積極處理相關聯復原點的備份任務。
+  `AVAILABLE` 狀態表示已成功為復原點建立備份。備份程序已完成，沒有任何問題，且復原點現在已準備好可供使用。
+  `PARTIAL` 狀態表示複合復原點具有一或多個不在備份中的巢狀復原點。
+  `EXPIRED` 狀態表示復原點已超過其保留期間，但 AWS Backup 缺少許可或無法刪除它。若要手動刪除這些復原點，請參閱《入門》**的《清理資源》**一節中的《[步驟 3：刪除復原點](https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups)》。
+  `STOPPED` 狀態會出現在連續備份，其中使用者已採取某些動作，導致連續備份停用。這可能是因為移除許可、關閉版本控制、關閉傳送至 EventBridge 的事件，或停用 AWS Backup設定的 EventBridge 規則所造成。對於 Amazon S3、Amazon RDS 和 Amazon Aurora 資源的復原點，此狀態會在連續備份規則的保留期間變更時發生。

  若要解決 `STOPPED` 狀態，請確定已具備所有必要許可，並且已在 S3 儲存貯體上啟用版本控制。一旦符合這些條件，下次執行備份規則就會建立新的連續復原點。不需要刪除狀態為「已停止」的復原點。

  至於 Amazon EC2 上的 SAP HANA，`STOPPED`會因為使用者動作、應用程式設定錯誤或備份失敗而發生。為確保未來的連續備份成功，請查看復原點狀態並檢查 SAP HANA 以取得詳細資訊。
類型：字串  
有效值:`COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING` 

 ** [StatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StatusMessage"></a>
說明還原復原點狀態的狀態訊息。  
類型：字串

 ** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StorageClass"></a>
指定復原點的儲存體方案。有效值為 `WARM` 或 `COLD`。  
類型：字串  
有效值:`WARM | COLD | DELETED` 

 ** [VaultType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-VaultType"></a>
存放所述復原點的保存庫類型。  
類型：字串  
有效值:`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

## 錯誤
<a name="API_DescribeRecoveryPoint_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_DescribeRecoveryPoint_SeeAlso"></a>

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