本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeBackupJob
返回指定项的备份任务详细信息BackupJobId
。
请求语法
GET /backup-jobs/backupJobId
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- backupJobId
-
唯一标识备份资源的请求。AWS Backup
必需:是
请求正文
该请求没有请求体。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"ChildJobsInState": {
"string" : number
},
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"IsParent": boolean,
"NumberOfChildJobs": number,
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- AccountId
-
返回拥有备份任务的账户 ID。
类型:字符串
模式:
^[0-9]{12}$
- BackupJobId
-
唯一标识备份资源的请求。AWS Backup
类型:字符串
- BackupOptions
-
表示作为备份计划或按需备份作业的一部分指定的选项。
类型:字符串到字符串映射
密钥模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
价值模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
- BackupSizeInBytes
-
备份大小(字节)。
类型:长整型
- BackupType
-
表示为备份作业选择的实际备份类型。例如,如果成功进行了 Windows 卷影复制服务 (VSS) 备份,则
BackupType
返回"WindowsVSS"
。如果BackupType
为空,则备份类型为常规备份。类型:字符串
- BackupVaultArn
-
唯一标识备份文件库的 Amazon 资源名称(ARN);例如,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
。类型:字符串
- BackupVaultName
-
用于存储备份的逻辑容器的名称。备份文件库由用于创建它们的账户和创建它们的 AWS 区域所特有的名称标识。它们包含小写字母、数字和连字符。
类型:字符串
模式:
^[a-zA-Z0-9\-\_]{2,50}$
- BytesTransferred
-
查询任务状态时传输到备份库的大小(以字节为单位)。
类型:长整型
- ChildJobsInState
-
这将返回所包含的子(嵌套)备份作业的统计信息。
类型:字符串到长映射
有效密钥:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
- CompletionDate
-
创建备份任务的任务的日期和时间,采用 Unix 格式和时间,采用 Unix 格式和时间,并采用 Unix 格式和时间 (Unix)。的值精
CompletionDate
确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30 .087。类型:时间戳
- CreatedBy
-
包含有关创建备份任务的识别信息
BackupPlanArn
,BackupPlanId
包括用于创建备份任务BackupRuleId
的备份计划的BackupPlanVersion
、、和。类型:RecoveryPointCreator 对象
- CreationDate
-
创建备份任务的日期和时间,采用 Unix 格式和时间,采用 Unix 格式和时间,并采用 Unix 格式和时间,并采用 Unix 格式 的值精
CreationDate
确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30 .087。类型:时间戳
- ExpectedCompletionDate
-
资源备份任务的日期和时间,采用 Unix 格式和时间,采用 Unix 格式和时间,并采用 Unix 格式和时间 (Unix)。的值精
ExpectedCompletionDate
确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30 .087。类型:时间戳
- IamRoleArn
-
指定用于创建目标恢复点的 IAM 角色 ARN;例如
arn:aws:iam::123456789012:role/S3Access
。类型:字符串
- IsParent
-
这将返回一个布尔值,表示备份作业是父(复合)作业。
类型:布尔值
- NumberOfChildJobs
-
这将返回子(嵌套)备份任务的数量。
类型:长整型
- ParentJobId
-
这将返回父(复合)资源备份作业 ID。
类型:字符串
- PercentDone
-
包含查询作业状态时作业完成的估计百分比。
类型:字符串
- RecoveryPointArn
-
唯一标识恢复点的 ARN;例如
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
。类型:字符串
- ResourceArn
-
唯一标识已保存资源的 ARN。ARN 的格式取决于资源类型。
类型:字符串
- ResourceName
-
这是属于指定备份的资源的非唯一名称。
类型:字符串
- ResourceType
-
要备份的AWS资源类型;例如 Amazon Elastic Block Store (Amazon EBS) 卷或Amazon Relational Block Store (Amazon Relational Database Service on EBS) 卷或Amazon RDS
类型:字符串
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
- StartBy
-
使用 Unix 格式和世界时 (UTC) 指定备份作业的时间 (UC),此时备份作业才会被取消。该值是通过将开始窗口与计划时间相加来计算的。因此,如果预定时间为下午 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
-
解释备份资源任务状态的详细消息。
类型:字符串
错误
有关所有操作常见错误的信息,请参阅常见错误。
- DependencyFailureException
-
依赖AWS服务或资源向AWS Backup服务返回了错误,操作无法完成。
HTTP 状态代码:500
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出范围。
HTTP 状态代码:400
- MissingParameterValueException
-
表示缺少必需的参数。
HTTP 状态代码:400
- ResourceNotFoundException
-
操作所需的资源不存在。
HTTP 状态代码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP 状态代码:500
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: