StartRestoreJob - AWS Backup
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

StartRestoreJob

恢复由Amazon Resource Name (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

用于创建目标资源的 IAM 角色的AWS Backup Amazon 资源名称（ARN）arn:aws:iam::123456789012:role/S3Access。

类型：字符串

必需：否

IdempotencyToken

客户选择的字符串，您可以使用它来区分原本相同的调用StartRestoreJob。使用相同的幂等令牌重试成功请求会生成成功消息，但不采取任何操作。

类型：字符串

必需：否

Metadata

一组元数据键值对。包含恢复点所需的信息，例如资源名称。

您可以通过调用获取有关备份资源时的配置元数据GetRecoveryPointRestoreMetadata。但是，恢复资源GetRecoveryPointRestoreMetadata可能需要除提供的值之外的值。例如，如果原始资源名称已经存在，则可能需要提供一个新的资源名称。

您需要指定特定的元数据来恢复 Amazon Elastic File System (Amazon EFS) 实例：

  • file-system-id：由备份的 Amazon EFS 文件系统的 IDAWS Backup。在 GetRecoveryPointRestoreMetadata 中返回。

  • Encrypted：一个布尔值，如果为 true，则指定文件系统已加密。如果指定了 KmsKeyId，则 Encrypted 必须设置为 true。

  • KmsKeyId：指定用于加密还原文件系统的AWS KMS 密钥。您可以指定另一个AWS账户的密钥，前提是该密钥已通过AWS KMS 与您的账户正确共享。

  • PerformanceMode：指定文件系统的吞吐量模式。

  • CreationToken：用户提供的值，用于确保请求的唯一性（幂等）。

  • newFileSystem：一个布尔值，如果为 true，则指定恢复点恢复到新的 Amazon EFS 文件系统。

  • ItemsToRestore: 由一到五个字符串组成的数组，其中每个字符串都是文件路径。ItemsToRestore用于恢复特定的文件或目录，而不是整个文件系统。此参数为可选项。例如，"itemsToRestore":"[\"/my.test\"]"。

类型：字符串到字符串映射

必需：是

RecoveryPointArn

唯一标识恢复点的 ARN；例如arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45。

类型：字符串

必需：是

ResourceType

启动作业以恢复以下资源之一的恢复点：

  • Aurora适用于Amazon Aurora

  • DocumentDBAmazon DocumentDB (with Mongo

  • CloudFormation for AWS CloudFormation

  • DynamoDB适用于Amazon DynamoDB

  • EBS适用于Amazon Elastic B

  • EC2适用于Amazon Elastic Co

  • EFS适用于Amazon Elastic File System

  • FSx适用于Amazon FSx

  • NeptuneAAmazon Neptune

  • RDS用于Amazon Relational Database Service

  • Redshift适用于Amazon Redshift f

  • Storage Gateway for AWS Storage Gateway

  • S3 适用于 Amazon S3 的

  • Timestreamfor Amazon Timestream

  • VirtualMachine用于虚拟机

类型：字符串

模式：^[a-zA-Z0-9\-\_\.]{1,50}$

必需：否

响应语法

HTTP/1.1 200
Content-type: application/json

{
   "RestoreJobId": "string"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

RestoreJobId

唯一标识还原恢复点的作业。

类型：字符串

错误

有关所有操作常见错误的信息，请参阅常见错误。

InvalidParameterValueException

表示参数的值有问题。例如，该值超出范围。

HTTP 状态代码：400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码：400

ResourceNotFoundException

操作所需的资源不存在。

HTTP 状态代码：400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码：500

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：