StartRestoreJob - Amazon Backup
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

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 角色的 Amazon ResAmazon Backup ource Name (ARN)；例如，arn:aws:iam::123456789012:role/S3Access。

类型：字符串

必需：否

IdempotencyToken

客户选择的字符串，您可以使用它来区分对的其他相同调用StartRestoreJob。使用相同的等效令牌重试成功请求会导致成功消息，但未采取任何操作。

类型：字符串

必需：否

Metadata

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

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

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

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

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

  • KmsKeyId：指定用于加密已恢复文件系统的Amazon KMS 密钥。您可以从其他Amazon账户指定密钥，前提是该密钥已通过Amazon 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

  • DocumentDBfor Amazon DocumentDB (with MongoDB

  • DynamoDB适用于Amazon DynamoDB

  • EBSFor Amazon Elastic

  • EC2for Amazon Elastic

  • EFSfor Amazon Elastic

  • FSxfor Amazon FSx

  • Neptune代表Amazon Neptune

  • RDS用于Amazon Relational Database Service

  • Storage Gateway for Amazon Storage Gateway

  • S3 适用于 Amazon S3 的

  • 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

另请参阅

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