StartRestoreJob - AWS Backup

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

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 提供的值之外,可能还需要其他值才能还原资源。例如,如果原始资源名称已存在,您可能需要提供一个新的资源名称。

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

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

  • Encrypted:一个布尔值,如果设为 true,则指定文件系统已加密。如果指定了 KmsKeyIdEncrypted 必须设置为 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

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

  • 适用于 Amazon Aurora 的 Aurora

  • 适用于 Amazon DocumentDB(与 MongoDB 兼容)的 DocumentDB

  • 适用于 AWS CloudFormation 的 CloudFormation

  • 适用于 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

  • 适用于 Amazon Redshift Redshift

  • 适用于 AWS Storage Gateway 的 Storage Gateway

  • 适用于 Amazon S3 的 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

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: