翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # GetBackupPlan 指定された `BackupPlanId` の `BackupPlan` 詳細情報を返します。詳細は、計画メタデータに加えて、JSON 形式のバックアッププランの本文です。 ## リクエストの構文 ``` GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [backupPlanId](#API_GetBackupPlan_RequestSyntax) ** バックアップ計画を一意に識別します。必須: はい ** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) ** プレビューする今後スケジュールされているバックアップ実行の数。0 (デフォルト) に設定すると、スケジュールされた実行のプレビューはレスポンスに含まれません。有効な範囲は 1～10 です。有効範囲: 最小値は 0 です。最大値は 10 です。 ** [VersionId](#API_GetBackupPlan_RequestSyntax) ** 一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。 ## リクエスト本文リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "AdvancedBackupSettings": [ { "BackupOptions": { "string" : "string" }, "ResourceType": "string" } ], "BackupPlan": { "AdvancedBackupSettings": [ { "BackupOptions": { "string" : "string" }, "ResourceType": "string" } ], "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean } } ], "EnableContinuousBackup": boolean, "IndexActions": [ { "ResourceTypes": [ "string" ] } ], "Lifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "RecoveryPointTags": { "string" : "string" }, "RuleId": "string", "RuleName": "string", "ScanActions": [ { "MalwareScanner": "string", "ScanMode": "string" } ], "ScheduleExpression": "string", "ScheduleExpressionTimezone": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string", "TargetLogicallyAirGappedBackupVaultArn": "string" } ], "ScanSettings": [ { "MalwareScanner": "string", "ResourceTypes": [ "string" ], "ScannerRoleArn": "string" } ] }, "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "ScheduledRunsPreview": [ { "ExecutionTime": number, "RuleExecutionType": "string", "RuleId": "string" } ], "VersionId": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [AdvancedBackupSettings](#API_GetBackupPlan_ResponseSyntax) ** 各リソースタイプごとに `BackupOptions` のリストが含まれます。このリストには、バックアッププランに詳細オプションが設定されている場合にのみ入力されます。型: [AdvancedBackupSetting](API_AdvancedBackupSetting.md) オブジェクトの配列 ** [BackupPlan](#API_GetBackupPlan_ResponseSyntax) ** バックアッププランの本文を指定します。1 つの `BackupPlanName` と1 つ以上の `Rules` のセットを含む。型: [BackupPlan](API_BackupPlan.md) オブジェクト ** [BackupPlanArn](#API_GetBackupPlan_ResponseSyntax) ** たとえば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。タイプ: 文字列 ** [BackupPlanId](#API_GetBackupPlan_ResponseSyntax) ** バックアップ計画を一意に識別します。タイプ: 文字列 ** [CreationDate](#API_GetBackupPlan_ResponseSyntax) ** バックアッププランが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。`CreationDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [CreatorRequestId](#API_GetBackupPlan_ResponseSyntax) ** オペレーションを 2 回実行するリスクなしに、失敗したリクエストを再試行でき、リクエストを識別する一意の文字列。タイプ: 文字列 ** [DeletionDate](#API_GetBackupPlan_ResponseSyntax) ** バックアップ計画が削除される日時 (Unix 形式および協定世界時 (UTC))。`DeletionDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [LastExecutionDate](#API_GetBackupPlan_ResponseSyntax) ** このバックアッププランが最後に実行された日時。日時は、Unix 形式および協定世界時 (UTC) です。`LastExecutionDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [ScheduledRunsPreview](#API_GetBackupPlan_ResponseSyntax) ** スケジュールされているバックアップ実行のリスト。`MaxScheduledRunsPreview` パラメータが 0 より大きい場合にのみ含まれます。最大で 10 件の将来のバックアップ実行を含み、それぞれにスケジュールされた時刻、実行タイプ、および関連するルール ID が含まれます。型: [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) オブジェクトの配列 ** [VersionId](#API_GetBackupPlan_ResponseSyntax) ** 一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。タイプ: 文字列 ## エラーすべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** InvalidParameterValueException ** パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** MissingParameterValueException ** 必須パラメータがないことを示します。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ResourceNotFoundException ** アクションに必要なリソースは存在しません。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ServiceUnavailableException ** サーバーの一時的障害のため、リクエストは失敗しました。 ** Context ** ** Type ** HTTP ステータスコード: 500 ## その他の参照資料言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupPlan)