本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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
},
"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
-
唯一标识资源的亚马逊资源名称 (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
-
注意:此字段仅针对亚马逊 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 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: