StartBackupJob - AWS Backup

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

StartBackupJob

指定されたリソースのオンデマンドバックアップジョブを開始します。

リクエストの構文

PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number }

URI リクエストパラメータ

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

リクエストボディ

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

BackupOptions

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

有効な値: に設定する"WindowsVSS":"enabled"を有効にするにはWindowsVSSバックアップオプションを選択し、Windows VSS バックアップを作成します。に設定する"WindowsVSS""disabled"の順に選択し、通常のバックアップを作成します。-WindowsVSSデフォルトでは、有効になっていません。

Type: 文字列から文字列へのマッピング

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

value Pattern^[a-zA-Z0-9\-\_\.]{1,50}$

必須: いいえ

BackupVaultName

バックアップを保存する論理コンテナの名前。Backup ボールトは、これらのボールトを作成するために使用されたアカウントに一意の名前で識別されます。AWSこれらのリージョンが作成されたリージョン。名前は、小文字の英文字、数字、およびハイフン (-) で構成されます。

Type: 文字列

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

必須: あり

CompleteWindowMinutes

正常に開始されたバックアップが完了しなければならない時間(分単位)。そうでない場合、AWS Backup はジョブをキャンセルします。この値はオプションです。この値は、バックアップがスケジュールされた時点からカウントダウンを開始します。追加時間は追加されませんStartWindowMinutesまたは、バックアップがスケジュールより遅れて開始された場合。

Type: Long

必須: いいえ

IamRoleArn

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

Type: 文字列

必須: あり

IdempotencyToken

顧客が選択した文字列です。StartBackupJobに対する呼び出しで、この文字列以外は同じ呼び出しと区別するために使用します。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。

Type: 文字列

必須: いいえ

Lifecycle

ライフサイクルにより、保護されたリソースがいつコールドストレージに移行するか、およびいつ期限切れになるかが定義されます。AWS Backup は、お客様が定義するライフサイクルに従って自動的にバックアップを移行し、期限切れにします。

コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、「有効期限 (日数)」の設定は、「コールドへの移行 (日数)」設定の 90 日後である必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。

Amazon EFS ファイルシステムのバックアップのみをコールドストレージに移行できます。

タイプ: Lifecycle オブジェクト

必須: いいえ

RecoveryPointTags

リソースを整理しやすくするために、作成したリソースに独自のメタデータを割り当てることができます。各タグはキーと値のペアです。

Type: 文字列から文字列へのマッピング

必須: いいえ

ResourceArn

リソースを一意に識別する Amazon リソースネーム (ARN)。ARN の形式はリソースのタイプによって異なります。

Type: 文字列

必須: あり

StartWindowMinutes

バックアップがスケジュールされてから、正常に開始されない場合にジョブがキャンセルされるまでの値 (分単位)。この値はオプションであり、デフォルトは 8 時間です。

Type: Long

必須: いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "RecoveryPointArn": "string" }

レスポンス要素

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

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

BackupJobId

リクエストを一意に識別するAWS Backupリソースをバックアップします。

Type: 文字列

CreationDate

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

Type: タイムスタンプ

RecoveryPointArn

リカバリポイントを一意に識別する ARN。たとえば、arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

Type: 文字列

Errors

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

InvalidParameterValueException

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

HTTP ステータスコード: 400

InvalidRequestException

リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。

HTTP ステータスコード: 400

LimitExceededException

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

HTTP ステータスコード: 400

MissingParameterValueException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

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

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