StartRestoreJob - AWS Backup

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

StartRestoreJob

Amazon リソースネーム (ARN) で識別された保存されたリソースを回復します。

リクエストの構文

PUT /restore-jobs HTTP/1.1 Content-type: application/json { "IamRoleArn": "string", "IdempotencyToken": "string", "Metadata": { "string" : "string" }, "RecoveryPointArn": "string", "ResourceType": "string" }

URI リクエストパラメータ

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

リクエストボディ

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

IamRoleArn

たとえば、arn:aws:iam::123456789012:role/S3Access などのターゲットリカバリポイントの作成に使用する IAM ロールの Amazon リソースネーム (ARN)。

Type: 文字列

: 必須 はい

IdempotencyToken

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

Type: 文字列

: 必須 いいえ

Metadata

メタデータのキーと値のペアのセット。リカバリポイントの復元に必要なリソース (リソース名など) を含みます。

GetRecoveryPointRestoreMetadata を呼び出して、バックアップ時にリソースに関する構成メタデータを取得できます。ただし、GetRecoveryPointRestoreMetadata によって提供される値に加えて値リソースの復元が必要になる場合があります。たとえば、元のリソースがすでに存在する場合は、新しいリソース名を指定する必要があります。

Amazon Elastic File System (Amazon EFS) インスタンスを復元するには、特定のメタデータを指定する必要があります。

  • file-system-id: AWS Backup によってバックアップされた Amazon EFS ファイルシステムの ID。GetRecoveryPointRestoreMetadata で返されます。

  • Encrypted: true の場合はファイルシステムの暗号化を指定するブール値。KmsKeyId が指定される場合、Encryptedtrue である必要があります。

  • KmsKeyId 復元されるファイルシステムを暗号化するために使用する AWS KMS キーを指定します。キーが AWS KMS を介して正しく共有されることを前提として、別の AWS アカウントからキーを指定できます。

  • PerformanceMode: ファイルシステムのスループットモードを指定します。

  • CreationToken: リクエストの一意性 (冪等性) を確認するユーザー指定の値。

  • newFileSystem: true の場合は復旧ポイントが新しい Amazon EFS ファイルシステムに復元されることを指定するブール値。

  • ItemsToRestore: 各文字列がファイルパスである 1 ~ 5 つの文字列の配列。ファイルシステム全体ではなく、特定のファイルまたはディレクトリを復元するために ItemsToRestore を使用します。このパラメータはオプションです。例えば、 "itemsToRestore":"[\"/my.test\"]"

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

: 必須 はい

RecoveryPointArn

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

Type: 文字列

: 必須 はい

ResourceType

次のいずれかのリソースのリカバリポイントを復元するジョブを開始します。

  • Amazon Aurora 用の Aurora

  • Amazon DocumentDB (MongoDB 互換性) 用の DocumentDB

  • Amazon DynamoDB 用の DynamoDB

  • Amazon Elastic Block Store 用の EBS

  • Amazon Elastic Compute Cloud 用の EC2

  • Amazon Elastic File System 用の EFS

  • Amazon FSx の場合 用の FSx

  • Amazon Neptune の場合 用の Neptune

  • Amazon Relational Database Service 用の RDS

  • AWS Storage Gateway 用の Storage Gateway

  • Amazon S3 用の S3

  • 仮想マシン用の VirtualMachine

Type: 文字列

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

: 必須 いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "RestoreJobId": "string" }

レスポンス要素

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

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

RestoreJobId

リカバリポイントをリストアするジョブを一意に識別します。

Type: 文字列

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード: 400

MissingParameterValueException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

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

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