StartBackupJob - Amazon Backup
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

StartBackupJob

针对指定资源启动按需备份作业。

请求语法

PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number }

URI 请求参数

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

请求体

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

BackupOptions

所选资源的备份选项。此选项仅适用于 Windows 卷影复制服务 (VSS) 备份作业。

有效值:设置为 "WindowsVSS":"enabled" 以启用 WindowsVSS 备份选项并创建 Windows VSS 备份。设置为 "WindowsVSS""disabled" 可创建常规备份。此 WindowsVSS 选项默认处于启用状态。

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

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

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

必需:否

BackupVaultName

用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。

类型:字符串

模式:^[a-zA-Z0-9\-\_]{2,50}$

必需:是

CompleteWindowMinutes

一个以分钟为单位的值,在此期间,成功启动的备份必须完成,否则 Amazon Backup 将取消该备份作业。该值为可选项。该值从计划备份时开始倒计时。如果备份的开始时间晚于计划时间,也不会为 StartWindowMinutes 额外增加时间。

比如 StartWindowMinutes,此参数的最大值为 100 年(52,560,000 分钟)。

类型:长整型

必需:否

IamRoleArn

指定用于创建目标恢复点的 IAM 角色 ARN;例如,arn:aws:iam::123456789012:role/S3Access

类型:字符串

必需:是

IdempotencyToken

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

类型:字符串

必需:否

Lifecycle

生命周期定义了受保护资源何时过渡到冷存储以及何时过期。 Amazon Backup 将根据您定义的生命周期自动过渡和过期备份。

转换到冷存储的备份必须在冷存储中存储至少 90 天。因此,“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后,无法更改“转换为冷态前经过的天数”设置。

按资源划分的功能可用性表中列出了可以过渡到冷存储的资源类型。 Amazon Backup 对于其他资源类型,将忽略此表达式。

此参数的最大值为 100 年(36,500 天)。

类型:Lifecycle 对象

必需:否

RecoveryPointTags

要分配给资源的标签。

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

必需:否

ResourceArn

唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。

类型:字符串

必需:是

StartWindowMinutes

一个时间值(以分钟为单位),用于指定在安排了备份之后,必须在多长时间内成功启动作业,否则将会被取消。这是可选值,默认值为 8 小时。如果包含此值,则必须至少为 60 分钟才能避免错误。

此参数的最大值为 100 年(52,560,000 分钟)。

在启动时段内,备份作业的状态将保持 CREATED 状态,直到成功启动或启动时段结束为止。如果在启动窗口内 Amazon Backup 收到允许重试作业的错误消息, Amazon Backup 则至少每 10 分钟自动重试一次以开始作业,直到备份成功开始(任务状态更改为RUNNING)或任务状态更改为EXPIRED(预计在启动窗口时间结束时发生)。

类型:长整型

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "IsParent": boolean, "RecoveryPointArn": "string" }

响应元素

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

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

BackupJobId

唯一标识 Amazon Backup 对的资源备份请求。

类型:字符串

CreationDate

备份作业的创建日期和时间,采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

IsParent

这是一个返回的布尔值,表示这是父(复合)备份作业。

类型:布尔值

RecoveryPointArn

注意:此字段仅针对 Amazon EFS 和高级 DynamoDB 资源返回相应的值。

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

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

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

HTTP 状态代码:400

InvalidRequestException

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

HTTP 状态代码:400

LimitExceededException

已超过请求中的限制;例如,请求中允许的最大项目数。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

另请参阅

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