DescribeRecoveryPoint - AWS Backup

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

DescribeRecoveryPoint

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

請求語法

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

URI請求參數

請求使用下列URI參數。

BackupVaultAccountId

指定備份儲存庫的帳戶 ID。

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

backupVaultName

存放備份的邏輯容器的名稱。備份文件庫依名稱識別,這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。

模式:^[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

備份的大小,以位元組為單位。

類型:Long

BackupVaultArn

唯ARN一識別備份儲存庫的;例如,arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

類型:字串

BackupVaultName

存放備份的邏輯容器的名稱。備份文件庫依名稱識別,這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。

類型:String

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

CalculatedLifecycle

包含 DeleteAtMoveToColdStorageAt 時間戳記的 CalculatedLifecycle 物件。

類型:CalculatedLifecycle 物件

CompletionDate

建立復原點的工作完成的日期和時間,格式為 Unix 格式和協調世界時 (UTC)。CompletionDate 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

CompositeMemberIdentifier

複合群組中資源的識別碼,例如屬於複合 (父系) 堆疊的巢狀 (子項) 復原點。ID 會從堆疊中的邏輯 ID 傳輸。

類型:字串

CreatedBy

含有建立復原點的相關識別資訊,包括用於建立復原點之備份計畫的 BackupPlanArnBackupPlanIdBackupPlanVersionBackupRuleId

類型:RecoveryPointCreator 物件

CreationDate

建立復原點的日期和時間,採用 Unix 格式和協調世界時 (UTC)。CreationDate 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

EncryptionKeyArn

用來保護備份的伺服器端加密金鑰,例如 arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

類型:字串

IamRoleArn

指定IAMARN用來建立目標復原點的角色,例如arn:aws:iam::123456789012:role/S3Access

類型:字串

IsEncrypted

如果指定的復原點已加密,則傳回的布林值為 TRUE;如果復原點未加密,則為 FALSE

類型:布林值

IsParent

這會傳回復原點為父項 (複合) 任務的布林值。

類型:布林值

LastRestoreTime

上次還原復原點的日期和時間,採用 Unix 格式和協調世界時 (UTC)。LastRestoreTime 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

Lifecycle

生命週期定義受保護資源何時轉換為冷存儲以及何時到期。 AWS Backup 根據您定義的生命週期,自動轉換備份並過期。

轉移至冷儲存的備份必須在冷儲存中存放至少 90 天。因此,「保留期」設定必須比「轉移至冷儲存前所需天數」設定長 90 天。「轉移至冷儲存前所需天數」設定在已有備份轉移至冷儲存後就無法再加以變更。

可轉換至冷藏的資源類型會列在「依資源分類的功能可用性」表格中。 AWS 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

要儲存為復原點的 AWS 資源類型;例如,Amazon 彈性區塊存放區 (AmazonEBS) 磁碟區或 Amazon Relational Database Service (AmazonRDS) 資料庫。

類型:String

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

SourceBackupVaultArn

Amazon 資源名稱 (ARN),可唯一識別最初備份資源所在的來源儲存庫;例如,arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault。如果恢復恢復到相同的 AWS 帳戶或區域,則此值將是null

類型:字串

Status

指定復原點狀態的狀態碼。

PARTIAL狀態表示 AWS Backup 無法在備份視窗關閉之前建立復原點。若要使用增加備份計劃視窗API,請參閱UpdateBackupPlan。您也可以使用主控台,透過選擇和編輯備份計畫來加長備份計畫時段。

EXPIRED狀態表示復原點已超過其保留期限,但 AWS Backup 缺少權限,或無法刪除它。若要手動刪除這些復原點,請參閱《入門》的《清理資源》一節中的《步驟 3:刪除復原點》。

STOPPED 狀態會出現在連續備份,其中使用者已採取某些動作,導致連續備份停用。這可能是因為移除權限、關閉版本控制、關閉要傳送至的事件 EventBridge,或停用由設定的 EventBridge 規則所造成 AWS Backup。對於 Amazon S3、Amazon 和 Amazon Aurora 資源的復原點,當連續備份規則的保留期變更時,就會發生此狀態。RDS

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

For SAP HANA on Amazon EC2 STOPPED 狀態是由於使用者動作、應用程式設定錯誤或備份失敗而發生的。若要確保 future 的持續備份成功,請參閱復原點狀態並檢查SAPHANA詳細資訊。

類型:字串

有效值:COMPLETED | PARTIAL | DELETING | EXPIRED

StatusMessage

說明還原復原點狀態的狀態訊息。

類型:字串

StorageClass

指定復原點的儲存體方案。有效值為 WARMCOLD

類型:字串

有效值:WARM | COLD | DELETED

VaultType

儲存所描述復原點的 Vault 類型。

類型:字串

有效值:BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InvalidParameterValueException

表示參數的值出現問題。例如,值超出範圍。

HTTP狀態碼:

MissingParameterValueException

表示缺少必要的參數。

HTTP狀態碼:

ResourceNotFoundException

動作所需的資源不存在。

HTTP狀態碼:

ServiceUnavailableException

由於伺服器發生臨時故障,請求失敗。

HTTP狀態碼:5

另請參閱

如需有關API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: