本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
BackupJob
包含有关备份作业的详细信息。
内容
- AccountId
-
拥有备份作业的账户 ID。
类型:字符串
模式:
^[0-9]{12}$
必需:否
- BackupJobId
-
唯一标识 Amazon Backup 对的资源备份请求。
类型:字符串
必需:否
- BackupOptions
-
为所选资源指定备份选项。此选项仅适用于 Windows 卷影复制服务 (VSS) 备份作业。
有效值:设置为
"WindowsVSS":"enabled"
以启用WindowsVSS
备份选项并创建 Windows VSS 备份。设置为"WindowsVSS":"disabled"
可创建常规备份。如果您指定的选项无效,则会出现InvalidParameterValueException
异常。类型:字符串到字符串映射
键模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
值模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
必需:否
- BackupSizeInBytes
-
备份的大小(以字节为单位)。
类型:长整型
必需:否
- BackupType
-
表示备份作业的备份类型。
类型:字符串
必需:否
- BackupVaultArn
-
唯一标识备份保管库的 Amazon 资源名称 (ARN);例如,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
。类型:字符串
必需:否
- BackupVaultName
-
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。名称包含小写字母、数字和连字符。
类型:字符串
模式:
^[a-zA-Z0-9\-\_]{2,50}$
必需:否
- BytesTransferred
-
查询作业状态时传输到备份保管库的大小(以字节为单位)。
类型:长整型
必需:否
- CompletionDate
-
创建备份作业的作业完成的日期和时间,采用 Unix 格式和协调世界时 (UTC)。
CompletionDate
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
必需:否
- CreatedBy
-
包含有关创建备份作业的标识信息,包括用于创建该作业的备份计划的
BackupPlanArn
、BackupPlanId
、BackupPlanVersion
和BackupRuleId
。类型:RecoveryPointCreator 对象
必需:否
- CreationDate
-
创建备份作业的日期和时间,采用 Unix 格式和协调世界时 (UTC)。
CreationDate
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
必需:否
- ExpectedCompletionDate
-
备份资源的作业预计完成的日期和时间,采用 Unix 格式和协调世界时 (UTC)。
ExpectedCompletionDate
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
必需:否
- IamRoleArn
-
指定用于创建目标恢复点的 IAM 角色 ARN。除默认角色之外的 IAM 角色必须在角色名称中包含
AWSBackup
或AwsBackup
。例如,arn:aws:iam::123456789012:role/AWSBackupRDSAccess
。如果没有这些字符串,角色名称将缺少执行备份作业的权限。类型:字符串
必需:否
- InitiationDate
-
这是备份作业的启动日期。
类型:时间戳
必需:否
- IsParent
-
这是一个布尔值,表示这是父(复合)备份作业。
类型:布尔值
必需:否
- MessageCategory
-
此参数是指定消息类别的作业计数。
例如,字符串可能包括
AccessDenied
、SUCCESS
、AGGREGATE_ALL
和INVALIDPARAMETERS
。有关 MessageCategory 字符串列表,请参阅监控。值 ANY 返回所有消息类别的计数。
AGGREGATE_ALL
汇总所有消息类别的作业计数并返回总和。类型:字符串
必需:否
- ParentJobId
-
它唯一地标识向 Amazon Backup 发出的备份资源请求。返回的将是父(复合)作业 ID。
类型:字符串
必需:否
- PercentDone
-
包含查询作业状态时作业完成的估计百分比。
类型:字符串
必需:否
- RecoveryPointArn
-
唯一标识恢复点的 ARN;例如,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
。类型:字符串
必需:否
- ResourceArn
-
唯一标识资源的 ARN。ARN 的格式取决于资源类型。
类型:字符串
必需:否
- ResourceName
-
它是属于指定备份的资源的非唯一名称。
类型:字符串
必需:否
- ResourceType
-
要备份的 Amazon 资源类型;例如,亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。对于 Windows 卷影复制服务 (VSS) 备份,唯一支持的资源类型是 Amazon EC2。
类型:字符串
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
必需:否
- StartBy
-
采用 Unix 格式和协调世界时 (UTC),指定备份作业必须在取消改作业之前多久启动。该值通过将启动时段与计划时间相加进行计算。因此,如果计划时间为下午 6:00,启动时段为 2 小时,则
StartBy
时间为指定日期的晚上 8:00。StartBy
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
必需:否
- State
-
备份作业的当前状态。
类型:字符串
有效值:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
必需:否
- StatusMessage
-
一条详细消息,解释备份资源作业的状态。
类型:字符串
必需:否
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: