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 リージョンに一意の名前で識別されます。

Pattern: ^[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" }

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。

次のデータは、 サービスによって JSON 形式で返されます。

BackupSizeInBytes

バックアップのサイズはバイト単位です。

型: 長整数

BackupVaultArn

バックアップボールトを一意に識別ARNする 。例: arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

型: 文字列

BackupVaultName

バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。

型: 文字列

パターン: ^[a-zA-Z0-9\-\_]{2,50}$

CalculatedLifecycle

DeleteAt および MoveToColdStorageAt タイムスタンプを含む CalculatedLifecycle オブジェクト。

型: CalculatedLifecycle オブジェクト

CompletionDate

リカバリポイントを作成するジョブが完了した日時。Unix 形式と協定世界時 () ですUTC。CompletionDate の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

CompositeMemberIdentifier

複合 (親) スタックに属するネストされた (子) リカバリポイントなど、複合グループ内のリソースの識別子。ID はスタック内の論理 ID から転送されます。

型: 文字列

CreatedBy

作成に使用したバックアッププランの BackupPlanArnBackupPlanIdBackupPlanVersion、および BackupRuleId を含むリカバリポイントの作成に関する識別情報を含んでいます。

型: 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

ターゲットリカバリポイントの作成ARNに使用されるIAMロールを指定します。例えば、 ですarn:aws:iam::123456789012:role/S3Access

型: 文字列

IsEncrypted

TRUE 指定したリカバリポイントが暗号化されている場合、または FALSE リカバリポイントが暗号化されていない場合かどうか返すブール値。

型: ブール値

IsParent

これにより、復旧ポイントが親 (複合) ジョブであることを示すブール値が返されます。

型: ブール値

LastRestoreTime

Unix 形式と協定世界時 () で、復旧ポイントが最後に復元された日時UTC。LastRestoreTime の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

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 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:backup-vault:aBackupVault。リカバリが同じ AWS アカウントまたはリージョンに復元された場合、この値は になりますnull

型: 文字列

Status

リカバリポイントの状態を指定するステータスコード。

PARTIAL ステータスは、バックアップウィンドウが閉じられる前にリカバリポイントを作成 AWS Backup できなかったことを示します。を使用してバックアッププランウィンドウを増やすにはAPI、「」を参照してくださいUpdateBackupPlan。コンソールを使用して、バックアッププランを選択、編集して、バックアッププランのウィンドウを増やすこともできます。

EXPIRED ステータスは、リカバリポイントが保持期間を過ぎたが、アクセス許可 AWS Backup がない、または削除できないことを示します。これらの復旧ポイントを手動で削除するには、「開始方法」の「リソースのクリーンアップ」セクションの「ステップ 3: 復旧ポイントの削除」を参照してください。

STOPPED ステータスは、継続的バックアップが無効になるような操作をユーザーが行った場合の継続的バックアップ時に発生します。これは、アクセス許可の削除、バージョニングの無効化、 に送信されるイベントの無効化 EventBridge、 によって設定された EventBridge ルールの無効化が原因である可能性があります AWS Backup。Amazon S3、Amazon RDS、および Amazon Aurora リソースのリカバリポイントの場合、このステータスは、継続的なバックアップルールの保持期間が変更されたときに発生します。

STOPPED ステータスを解決するには、要求されたアクセス許可がすべて揃っていて、S3 バケットでバージョニングが有効になっていることを確認してください。これらの条件が満たされると、実行されるバックアップルールの次のインスタンスでは、新しい継続的復旧ポイントが作成されます。STOPPED ステータスが のリカバリポイントは削除する必要はありません。

SAP HANA オン Amazon EC2STOPPEDステータスは、ユーザーアクション、アプリケーションの設定ミス、またはバックアップの失敗が原因で発生します。将来の継続的なバックアップを確実に成功させるには、復旧ポイントのステータスを参照してSAPHANA詳細を確認してください。

型: 文字列

有効な値: COMPLETED | PARTIAL | DELETING | EXPIRED

StatusMessage

復旧ポイントのステータスを説明する詳細なメッセージです。

型: 文字列

StorageClass

リカバリポイントのストレージクラスを指定します。有効な値は WARM または COLD です。

型: 文字列

有効な値: WARM | COLD | DELETED

VaultType

記述された復旧ポイントが保存されるボールトのタイプ。

型: 文字列

有効な値: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード: 400

MissingParameterValueException

必須パラメータがないことを示します。

HTTP ステータスコード: 400

ResourceNotFoundException

アクションに必要なリソースは存在しません。

HTTP ステータスコード: 400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード: 500

以下の資料も参照してください。

言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。