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

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

StartRestoreJob

恢复由 Amazon 资源名称 (ARN) 标识的已保存资源。

请求语法

PUT /restore-jobs HTTP/1.1
Content-type: application/json

{
   "CopySourceTagsToRestoredResource": boolean,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Metadata": { 
      "string" : "string" 
   },
   "RecoveryPointArn": "string",
   "ResourceType": "string"
}

URI请求参数

该请求不使用任何URI参数。

请求正文

该请求接受以下JSON格式的数据。

CopySourceTagsToRestoredResource

此参数为可选参数。如果此值等于 True，则备份中包含的标签将被复制到已还原的资源中。

这只能应用于通过创建的备份 AWS Backup。

类型：布尔值

必需：否

IamRoleArn

AWS Backup 用于创建目标资源的IAM角色的 Amazon 资源名称 (ARN)；例如：arn:aws:iam::123456789012:role/S3Access。

类型：字符串

必需：否

IdempotencyToken

客户选择的字符串，可用于区分对 StartRestoreJob 的其他相同调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息，而不执行任何操作。

类型：字符串

必需：否

Metadata

一组元数据键值对。

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

有关每种资源的元数据的更多信息，请参阅以下内容：

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

必需：是

RecoveryPointArn

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

类型：字符串

必需：是

ResourceType

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

  • Aurora-亚马逊 Aurora

  • DocumentDB-亚马逊 DocumentDB

  • CloudFormation - AWS CloudFormation

  • DynamoDB-亚马逊 DynamoDB

  • EBS-亚马逊 Elastic Block

  • EC2-Amazon 弹性计算云

  • EFS-亚马逊 Elastic File System

  • FSx-亚马逊 FSx

  • Neptune-亚马逊 Neptune

  • RDS-亚马逊 Relational Database Service

  • Redshift-亚马逊 Redshift

  • Storage Gateway - AWS Storage Gateway

  • S3-Amazon 简单存储服务

  • Timestream-亚马逊 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

InvalidRequestException

表示请求的输入有问题。例如，参数的类型错误。

HTTP状态码：400

MissingParameterValueException

表示缺少必需的参数。

HTTP状态码：400

ResourceNotFoundException

该操作所需的资源不存在。

HTTP状态码：400

ServiceUnavailableException

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

HTTP状态码：500

另请参阅

有关API在一种特定语言中使用此功能的更多信息 AWS SDKs，请参阅以下内容：