本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 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 ，這表示此顯示值可能表示實際備份大小不足。類型：Long ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) ** 代表針對備份任務所選取的實際備份類型。例如，如果成功取得 Windows 磁碟區陰影複製服務 (VSS) 備份，`BackupType` 會傳回 `"WindowsVSS"`。如果 `BackupType` 為空，則備份類型為定期備份。類型：字串 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) ** 可唯一識別備份文件庫的 Amazon Resource Name (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) ** 查詢任務狀態時傳輸至備份文件庫的大小 (以位元組為單位)。類型：Long ** [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 秒。類型：Timestamp ** [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 秒。類型：Timestamp ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) ** 用來加密備份之 KMS 金鑰的 Amazon Resource Name (ARN)。這可以是客戶受管金鑰或 AWS 受管金鑰，取決於保存庫組態。類型：字串 ** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) ** 某任務備份資源預期完成的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`ExpectedCompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型：Timestamp ** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) ** 指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。類型：字串 ** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) ** 備份任務啟動的日期。類型：Timestamp ** [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) ** 這會傳回子 (巢狀) 備份任務的數目。類型：Long ** [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`和指定 -1`DeleteAfterDays`。類型：[Lifecycle](API_Lifecycle.md) 物件 ** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) ** 可唯一識別已儲存資源的 ARN。ARN 的格式取決於資源類型。類型：字串 ** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) ** 屬於指定備份之資源的非唯一名稱。類型：字串 ** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) ** 要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。類型：字串模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) ** 指定在備份任務取消之前必須開始的時間，以 Unix 格式和國際標準時間 (UTC) 顯示。該值是透過將開始時段加至排定時間來計算。因此，如果排定的時間為下午 6 點，而開始時段為 2 小時，則 `StartBy` 時間將是指定日期的下午 8 點。`StartBy` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型：Timestamp ** [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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupJob) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) + [AWS 適用於 Python 的 SDK](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)