DescribeRecoveryPoint - Amazon Backup
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

DescribeRecoveryPoint

返回与恢复点关联的元数据,包括 ID、状态、加密和生命周期。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

BackupVaultAccountId

这是指定的备份保管库的账户 ID。

模式:^[0-9]{12}$

backupVaultName

用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。名称包含小写字母、数字和连字符。

模式:^[a-zA-Z0-9\-\_]{2,50}$

必需:是

recoveryPointArn

唯一标识恢复点的 Amazon 资源名称 (ARN);例如,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

必需:是

请求体

该请求没有请求体。

响应语法

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", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "IamRoleArn": "string", "IsEncrypted": boolean, "IsParent": boolean, "LastRestoreTime": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "ParentRecoveryPointArn": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "Status": "string", "StatusMessage": "string", "StorageClass": "string", "VaultType": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

BackupSizeInBytes

备份的大小(以字节为单位)。

类型:长整型

BackupVaultArn

唯一标识备份保管库的 ARN;例如,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault

类型:字符串

BackupVaultName

用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 区域中是唯一的。名称包含小写字母、数字和连字符。

类型:字符串

模式:^[a-zA-Z0-9\-\_]{2,50}$

CalculatedLifecycle

包含 DeleteAtMoveToColdStorageAt 时间戳的 CalculatedLifecycle 对象。

类型:CalculatedLifecycle 对象

CompletionDate

恢复点创建作业的完成日期和时间,采用 Unix 格式和协调世界时 (UTC)。CompletionDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

CompositeMemberIdentifier

这是复合组中资源的标识符,例如属于复合(父)堆栈的嵌套(子)恢复点。ID 是从堆栈内的逻辑 ID 中传输的。

类型:字符串

CreatedBy

包含有关创建恢复点的识别信息,包括用于创建该恢复点的备份计划的 BackupPlanArnBackupPlanIdBackupPlanVersionBackupRuleId

类型:RecoveryPointCreator 对象

CreationDate

恢复点的创建日期和时间,采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

EncryptionKeyArn

用于保护备份的服务器端加密密钥;例如,arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

类型:字符串

IamRoleArn

指定用于创建目标恢复点的 IAM 角色 ARN;例如,arn:aws:iam::123456789012:role/S3Access

类型:字符串

IsEncrypted

一个布尔值,如果指定的恢复点已加密,则返回 TRUE,如果恢复点未加密,则返回 FALSE

类型:布尔值

IsParent

这将返回一个布尔值,即恢复点是父(复合)作业。

类型:布尔值

LastRestoreTime

恢复点的上次还原日期和时间,采用 Unix 格式和协调世界时 (UTC)。LastRestoreTime 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

Lifecycle

生命周期定义受保护的资源何时转换到冷存储以及何时过期。Amazon Backup 将根据您定义的生命周期自动转换备份和使备份过期。

转换到冷存储的备份必须在冷存储中存储至少 90 天。因此,“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后,无法更改“转换为冷态前经过的天数”设置。

可以转换到冷存储的资源类型在按资源划分的特征可用性表的“转换到冷存储的生命周期”部分中列出。对于其他资源类型,Amazon Backup 会忽略此表达式。

类型:Lifecycle 对象

ParentRecoveryPointArn

这是唯一标识父(复合)恢复点的 ARN;例如,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

类型:字符串

RecoveryPointArn

唯一标识恢复点的 ARN;例如,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

类型:字符串

ResourceArn

唯一标识所保存资源的 ARN。ARN 的格式取决于资源类型。

类型:字符串

ResourceName

它是属于指定备份的资源的非唯一名称。

类型:字符串

ResourceType

保存为恢复点的 Amazon 资源类型;例如 Amazon Elastic Block Store (Amazon EBS) 卷或 Amazon Relational Database Service (Amazon RDS) 数据库。

类型:字符串

模式:^[a-zA-Z0-9\-\_\.]{1,50}$

SourceBackupVaultArn

唯一标识资源最初备份的源保管库的 Amazon 资源名称 (ARN);例如,arn:aws:backup:us-east-1:123456789012:vault:BackupVault。如果恢复还原为相同的 Amazon 账户或区域,则该值将为 null

类型:字符串

Status

指定恢复点状态的状态码。

PARTIAL 状态表示 Amazon Backup 在备份时段结束之前无法创建恢复点。要使用 API 延长备份计划窗口,请参阅UpdateBackupPlan。您还可以使用控制台,通过选择和编辑备份计划来延长备份计划时段。

EXPIRED 状态表示恢复点已超过其保留期,但 Amazon Backup 缺少权限或无法将其删除。要手动删除这些恢复点,请参阅入门章节清理资源部分中的步骤 3:删除恢复点

当用户执行某些操作导致连续备份被禁用时,连续备份中会出现 STOPPED 状态。这可能是由于移除权限、关闭版本控制、关闭发送到 EventBridge的事件或禁用由Amazon Backup制定的 EventBridge 规则造成的。

要解决 STOPPED 状态问题,请确保请求的所有权限均已准备就绪,并且已在 S3 存储桶上启用版本控制。满足这些条件后,下一个运行的备份规则实例将导致创建新的连续恢复点。不需要删除处于 STOPPED 状态的恢复点。

对于 Amazon EC2 上的 SAP HANA,STOPPED 状态是由于用户操作、应用程序配置错误或备份失败而导致的。要确保日后连续备份成功,请参阅恢复点状态并查看 SAP HANA,以了解详细信息。

类型:字符串

有效值:COMPLETED | PARTIAL | DELETING | EXPIRED

StatusMessage

解释恢复点状态的状态消息。

类型:字符串

StorageClass

指定恢复点的存储类别。有效值为 WARMCOLD

类型:字符串

有效值:WARM | COLD | DELETED

VaultType

这是用于存储所述恢复点的保管库类型。

类型:字符串

有效值:BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

该操作所需的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: