本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeBackupJob
返回指定 BackupJobId
的备份作业详细信息。
请求语法
GET /backup-jobs/backupJobId
HTTP/1.1
URI请求参数
该请求使用以下URI参数。
- backupJobId
-
唯一标识 Amazon 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",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"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
-
唯一标识 Amazon 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:backup-vault:aBackupVault
。类型:字符串
- BackupVaultName
-
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。
类型:字符串
模式:
^[a-zA-Z0-9\-\_]{2,50}$
- BytesTransferred
-
查询作业状态时传输到备份保管库的大小(以字节为单位)。
类型:长整型
- ChildJobsInState
-
这将返回包含的子(嵌套)备份作业的统计信息。
类型:字符串到长整型映射
有效密钥:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
- 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
-
指定ARN用于创建目标恢复点的IAM角色;例如
arn:aws:iam::123456789012:role/S3Access
。类型:字符串
- InitiationDate
-
启动备份任务的日期。
类型:时间戳
- IsParent
-
这将返回一个布尔值,即备份作业是父(复合)作业。
类型:布尔值
- MessageCategory
-
指定消息类别的任务计数。
例如,字符串可能包括
AccessDenied
、SUCCESS
、AGGREGATE_ALL
和INVALIDPARAMETERS
。查看 “监控”,查看可接受的 MessageCategory 字符串列表。类型:字符串
- 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
-
要备份的 Amazon 资源类型;例如,亚马逊弹性区块存储 (AmazonEBS) 卷或亚马逊关系数据库服务 (AmazonRDS) 数据库。
类型:字符串
模式:
^[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
-
一条详细消息,解释备份资源作业的状态。
类型:字符串
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- DependencyFailureException
-
依赖的 Amazon 服务或资源向该 Amazon Backup 服务返回了错误,操作无法完成。
HTTP状态码:500
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出了范围。
HTTP状态码:400
- MissingParameterValueException
-
表示缺少必需的参数。
HTTP状态码:400
- ResourceNotFoundException
-
该操作所需的资源不存在。
HTTP状态码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP状态码:500
另请参阅
有关API在一种特定语言中使用此功能的更多信息 Amazon SDKs,请参阅以下内容: