選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

DescribeBackupJob

焦點模式
DescribeBackupJob - AWS Backup

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

傳回指定之 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", "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

可唯一識別 AWS Backup 對 備份資源的請求。

類型:字串

BackupOptions

代表指定為備份計畫或隨需備份任務之一部分的選項。

類型:字串到字串映射

金鑰模式:^[a-zA-Z0-9\-\_\.]{1,50}$

值模式:^[a-zA-Z0-9\-\_\.]{1,50}$

BackupSizeInBytes

備份的大小,以位元組為單位 (復原點)。

此值的轉譯方式會因從其他 AWS 服務 AWS Backup 提取資料資訊的資源類型而有所不同。例如,傳回的值可能顯示 的值0,這可能與預期值不同。

依資源類型列出的值預期行為如下所述:

  • Amazon Aurora、Amazon DocumentDB 和 Amazon Neptune 不會從操作 填入此值GetBackupJobStatus

  • 對於具有進階功能的 Amazon DynamoDB,此值是指復原點 (備份) 的大小。

  • Amazon EC2 和 Amazon EBS 會顯示在此值中傳回的磁碟區大小 (佈建儲存)。Amazon EBS 不會傳回備份大小資訊;快照大小的值將與備份的原始資源相同。

  • 對於 Amazon EFS,此值是指備份期間傳輸的差異位元組。

  • Amazon FSx 不會從 GetBackupJobStatus FSx 檔案系統的 操作填入此值。

  • Amazon RDS 執行個體會顯示為 0

  • 對於執行 VMware 的虛擬機器,此值會透過非同步工作流程傳遞至 AWS Backup ,這表示此顯示值可能代表實際備份大小不足。

類型:Long

BackupType

代表針對備份任務所選取的實際備份類型。例如,如果成功取得 Windows 磁碟區陰影複製服務 (VSS) 備份,BackupType 會傳回 "WindowsVSS"。如果 BackupType 為空,則備份類型為定期備份。

類型:字串

BackupVaultArn

可唯一識別備份文件庫的 Amazon Resource Name (ARN),例如 arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

類型:字串

BackupVaultName

存放備份的邏輯容器的名稱。備份文件庫依名稱識別,這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。

類型:字串

模式:^[a-zA-Z0-9\-\_]{2,50}$

BytesTransferred

查詢任務狀態時傳輸至備份文件庫的大小 (以位元組為單位)。

類型:Long

ChildJobsInState

這會傳回所包含之子 (巢狀) 複製任務的統計資訊。

類型:字串到長映射

有效金鑰:CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

某任務建立備份任務的完成日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。CompletionDate 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

CreatedBy

含有建立備份任務的相關識別資訊,包括用以建立備份任務之備份計畫的 BackupPlanArnBackupPlanIdBackupPlanVersionBackupRuleId

類型:RecoveryPointCreator 物件

CreationDate

建立備份任務時的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。CreationDate 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

ExpectedCompletionDate

某任務備份資源預期完成的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。ExpectedCompletionDate 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

IamRoleArn

指定用來建立目標復原點的 IAM 角色 ARN;例如 arn:aws:iam::123456789012:role/S3Access

類型:字串

InitiationDate

備份任務啟動的日期。

類型:Timestamp

IsParent

這會傳回備份任務為父項 (複合) 任務的布林值。

類型:布林值

MessageCategory

指定訊息類別的任務計數。

範例字串可能包括 AccessDeniedSUCCESSAGGREGATE_ALLINVALIDPARAMETERS。查看監控以取得接受的 MessageCategory 字串清單。

類型:字串

NumberOfChildJobs

這會傳回子 (巢狀) 備份任務的數目。

類型:Long

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 Database Service (Amazon RDS) 資料庫。

類型:字串

模式:^[a-zA-Z0-9\-\_\.]{1,50}$

StartBy

指定在備份任務取消之前必須開始的時間,以 Unix 格式和國際標準時間 (UTC) 顯示。該值是透過將開始時段加至排定時間來計算。因此,如果排定的時間為下午 6 點,而開始時段為 2 小時,則 StartBy 時間將是指定日期的下午 8 點。StartBy 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

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 SDKs中使用此 API 的詳細資訊,請參閱下列內容:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。