

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

# 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 资源名称 (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>
备份的大小（以字节为单位）。  
类型：长整型

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

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

 ** [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，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`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）。  
类型：时间戳

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

 ** [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 EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
包含针对恢复点的最新扫描结果，当前包括`MalwareScanner``ScanJobState`、`Findings`、和 `LastScanTimestamp`   
类型：[ScanResult](API_ScanResult.md) 对象数组  
数组成员：最少 0 个物品。最多 5 项。

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
唯一标识资源最初备份的源保管库的 Amazon 资源名称 (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`status 表示已为资源启动 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 存储桶上启用版本控制。满足这些条件后，下一个运行的备份规则实例将导致创建新的连续恢复点。不需要删除处于 STOPPED 状态的恢复点。

  对于 SAP HANA，Amazon 上的 EC2`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>

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