CreateBackupPlan - AWS Backup
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateBackupPlan

バックアッププラン名およびバックアップルールを使用してバックアッププランを作成します。バックアッププランは、 AWS Backup がリソースのリカバリポイントを作成するタスクをスケジュールするために使用する情報を含むドキュメントです。

CreateBackupPlan すでに存在するプランで電話する場合は、AlreadyExistsException の例外を受信します。

リクエストの構文

PUT /backup/plans/ HTTP/1.1
Content-type: application/json

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string"
         }
      ]
   },
   "BackupPlanTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string"
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

BackupPlan

バックアッププランの本文。1 つの BackupPlanName と1 つ以上の Rules のセットを含む。

型: BackupPlanInput オブジェクト

必須: はい

BackupPlanTags

バックアッププランに割り当てるタグ。

型: 文字列間のマッピング

必須: いいえ

CreatorRequestId

オペレーションを 2 回実行するリスクなしに、リクエストを識別し、失敗したリクエストを再試行できます。リクエストに既存のバックアッププランと一致する CreatorRequestId が含まれる場合、そのプランが返されます。このパラメータはオプションです。

使用する場合、このパラメータには 1～50 文字の英数字または「-_」を含める必要があります 。

タイプ: 文字列

必須: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "VersionId": "string"
}

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

AdvancedBackupSettings

リソースタイプの設定。このオプションは、Windows ボリュームシャドウコピーサービス (VSS) バックアップジョブでのみ使用できます。

型: AdvancedBackupSetting オブジェクトの配列

BackupPlanArn

たとえば、arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。

型: 文字列

BackupPlanId

バックアッププランの ID。

型: 文字列

CreationDate

バックアッププランが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。CreationDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

VersionId

一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。編集することはできません。

型: 文字列

エラー

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

AlreadyExistsException

必要なリソースは既に存在します。

HTTP ステータスコード：400

InvalidParameterValueException

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

HTTP ステータスコード：400

LimitExceededException

たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。

HTTP ステータスコード：400

MissingParameterValueException

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

HTTP ステータスコード：400

ServiceUnavailableException

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

HTTP ステータスコード：500

その他の参照資料

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