本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
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",
"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
-
備份的大小，以位元組為單位。
類型：Long
- BackupType
-
代表針對備份任務所選取的實際備份類型。例如，如果使用成功的 Windows Volume Shadow Copy Service （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
-
含有建立備份任務的相關識別資訊，包括用以建立備份任務之備份計畫的
BackupPlanArn、BackupPlanId、BackupPlanVersion和BackupRuleId。類型：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
-
指定ARN用來建立目標復原點IAM的角色；例如
arn:aws:iam::123456789012:role/S3Access。類型：字串
- InitiationDate
-
備份任務啟動的日期。
類型：Timestamp
- IsParent
-
這會傳回備份任務為父項 (複合) 任務的布林值。
類型：布林值
- MessageCategory
-
指定訊息類別的任務計數。
範例字串可能包括
AccessDenied、SUCCESS、AGGREGATE_ALL和INVALIDPARAMETERS。檢視監控，以取得已接受 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
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
