本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # DescribeBackupJob 返回指定 `BackupJobId` 的备份作业详细信息。 ## 请求语法 ``` GET /backup-jobs/backupJobId HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [backupJobId](#API_DescribeBackupJob_RequestSyntax) ** 唯一标识 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", "BackupPlanName": "string", "BackupPlanVersion": "string", "BackupRuleCron": "string", "BackupRuleId": "string", "BackupRuleName": "string", "BackupRuleTimezone": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "ExpectedCompletionDate": number, "IamRoleArn": "string", "InitiationDate": number, "IsEncrypted": boolean, "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RecoveryPointLifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string", "VaultLockState": "string", "VaultType": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [AccountId](#API_DescribeBackupJob_ResponseSyntax) ** 返回拥有备份作业的账户 ID。类型：字符串模式：`^[0-9]{12}$` ** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) ** 唯一标识 AWS Backup 对的资源备份请求。类型：字符串 ** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) ** 表示作为备份计划或按需备份作业的一部分而指定的选项。类型：字符串到字符串映射键模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` 值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` ** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) ** 备份（恢复点）的大小（以字节为单位）。当从其他 AWS 服务中 AWS Backup 提取数据信息时，根据资源类型，此值的呈现方式可能有所不同。例如，返回的值可能显示为 `0`，该值可能与预期值存在差异。按资源类型划分的值的预期行为描述如下： + Amazon Aurora、Amazon DocumentDB 和 Amazon Neptune 不会通过操作 `GetBackupJobStatus` 填充此值。 + 对于具有高级功能的 Amazon DynamoDB，此值是指恢复点（备份）的大小。 + Amazon EC2 和 Amazon EBS 会显示作为该值一部分返回的卷大小（预配置存储）。Amazon EBS 不返回备份大小信息；快照大小将与备份的原始资源具有相同的值。 + 对于 Amazon EFS，此值是指备份期间传输的增量字节数。 + 对于 Amazon EKS，此值是指嵌套的 EKS 恢复点的大小。 + Amazon FSx 不会从 FSx 文件系统的操作`GetBackupJobStatus`中填充此值。 + Amazon RDS 实例将显示为 `0`。 + 对于正在运行的虚拟机 VMware，此值将 AWS Backup 通过异步工作流程传递给，这可能意味着此显示的值可能低估了实际备份大小。类型：长整型 ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) ** 表示为备份作业选择的实际备份类型。例如，如果成功进行了 Windows 卷影复制服务 (VSS) 备份，则 `BackupType` 会返回 `"WindowsVSS"`。如果 `BackupType` 为空，则备份类型为常规备份。类型：字符串 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) ** 唯一标识备份保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。类型：字符串 ** [BackupVaultName](#API_DescribeBackupJob_ResponseSyntax) ** 用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。类型：字符串模式：`^[a-zA-Z0-9\-\_]{2,50}$` ** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) ** 查询作业状态时传输到备份保管库的大小（以字节为单位）。类型：长整型 ** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) ** 这将返回包含的子（嵌套）备份作业的统计信息。类型：字符串到长整型映射有效密钥：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` ** [CompletionDate](#API_DescribeBackupJob_ResponseSyntax) ** 创建备份作业的作业完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [CreatedBy](#API_DescribeBackupJob_ResponseSyntax) ** 包含有关创建备份作业的识别信息，包括用于创建该作业的备份计划的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。类型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 对象 ** [CreationDate](#API_DescribeBackupJob_ResponseSyntax) ** 备份作业的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) ** 用于加密备份的 KMS 密钥的 Amazon 资源名称（ARN）。这可以是客户管理的密钥，也可以是 AWS 托管密钥，具体取决于保管库的配置。类型：字符串 ** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) ** 资源备份作业的预期完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`ExpectedCompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) ** 指定用于创建目标恢复点的 IAM 角色 ARN；例如，`arn:aws:iam::123456789012:role/S3Access`。类型：字符串 ** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) ** 备份作业的启动日期。类型：时间戳 ** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) ** 指示是否对备份进行加密的布尔值。中的所有备份 AWS Backup 均已加密，但为了透明起见，此字段会显示加密状态。类型：布尔值 ** [IsParent](#API_DescribeBackupJob_ResponseSyntax) ** 这将返回一个布尔值，即备份作业是父（复合）作业。类型：布尔值 ** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) ** 指定消息类别的作业计数。例如，字符串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `INVALIDPARAMETERS`。查看[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)，查看可接受的 MessageCategory 字符串列表。类型：字符串 ** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) ** 这将返回子（嵌套）备份作业的数量。类型：长整型 ** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) ** 这将返回父（复合）资源备份作业 ID。类型：字符串 ** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) ** 包含在查询作业状态时作业已完成的估计百分比。类型：字符串 ** [RecoveryPointArn](#API_DescribeBackupJob_ResponseSyntax) ** 唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。类型：字符串 ** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) ** 指定恢复点转换为冷存储或删除前经过的天数。过渡到冷存储的备份必须在冷库中存储至少 90 天。因此，在控制台上，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。按资源划分的[功能可用性表中列出了可以过渡到冷存储的资源](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)类型。 AWS Backup 对于其他资源类型，将忽略此表达式。要删除现有的生命周期和保留期以便无限期保留恢复点，请为 `MoveToColdStorageAfterDays` 和 `DeleteAfterDays` 指定 -1。类型：[Lifecycle](API_Lifecycle.md) 对象 ** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) ** 唯一标识所保存资源的 ARN。ARN 的格式取决于资源类型。类型：字符串 ** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) ** 属于指定备份的资源的非唯一名称。类型：字符串 ** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) ** 要备份的 AWS 资源类型；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。类型：字符串模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) ** 采用 Unix 格式和协调世界时 (UTC)，指定备份作业必须在取消改作业之前多久启动。该值通过将启动时段与计划时间相加进行计算。因此，如果计划时间为下午 6:00，启动时段为 2 小时，则 `StartBy` 时间为指定日期的晚上 8:00。`StartBy` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [State](#API_DescribeBackupJob_ResponseSyntax) ** 备份作业的当前状态。类型：字符串有效值：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` ** [StatusMessage](#API_DescribeBackupJob_ResponseSyntax) ** 一条详细消息，解释备份资源作业的状态。类型：字符串 ** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) ** 备份保管库的锁定状态。对于逻辑上受物理隔离的保管库，这表明该保管库是否被锁定在合规模式下。有效值包括 `LOCKED` 和 `UNLOCKED`。类型：字符串 ** [VaultType](#API_DescribeBackupJob_ResponseSyntax) ** 存储恢复点的备份保管库的类型。标准备份保管库的有效值为 `BACKUP_VAULT`，逻辑上受物理隔离的保管库的有效值为 `LOGICALLY_AIR_GAPPED_BACKUP_VAULT`。类型：字符串 ## 错误有关所有操作的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。 ** DependencyFailureException ** 依赖的 AWS 服务或资源向该 AWS Backup 服务返回了错误，操作无法完成。 ** Context ** ** Type ** HTTP 状态代码：500 ** InvalidParameterValueException ** 表示参数的值有问题。例如，该值超出了范围。 ** Context ** ** Type ** HTTP 状态代码：400 ** MissingParameterValueException ** 表示缺少必需的参数。 ** Context ** ** Type ** HTTP 状态代码：400 ** ResourceNotFoundException ** 该操作所需的资源不存在。 ** Context ** ** Type ** HTTP 状态代码：400 ** ServiceUnavailableException ** 由于服务器发生临时故障而导致请求失败。 ** Context ** ** Type ** HTTP 状态代码：500 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupJob)