本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
BackupJob
包含備份作業的相關詳細資訊。
目錄
- AccountId
-
擁有備份作業的帳戶 ID。
類型:String
模式:
^[0-9]{12}$
必要:否
- BackupJobId
-
唯一識別備份 AWS Backup 資源的請求。
類型:字串
必要:否
- BackupOptions
-
可指定所選資源的備份選項。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份工作。
有效值:設定
"WindowsVSS":"enabled"
為啟用WindowsVSS
備份選項並建立 Windows VSS 備份。設定為"WindowsVSS":"disabled"
即可建立一般備份。如果您指定了無效的選項,則會出現InvalidParameterValueException
的例外狀況。類型:字串到字串映射
金鑰模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
值模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
必要:否
- BackupSizeInBytes
-
備份的大小,以位元組為單位。
類型:Long
必要:否
- BackupType
-
代表備份作業的備份類型。
類型:字串
必要:否
- BackupVaultArn
-
可唯一識別備份儲存庫的 Amazon 資源名稱 (ARN),例如
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
。類型:字串
必要:否
- BackupVaultName
-
存放備份的邏輯容器的名稱。備份文件庫依名稱識別,這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。
類型:String
模式:
^[a-zA-Z0-9\-\_]{2,50}$
必要:否
- BytesTransferred
-
查詢作業狀態時傳輸至備份保存庫的大小 (以位元組為單位)。
類型:Long
必要:否
- 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
-
指定IAMARN用來建立目標復原點的角色。IAM預設角色以外的角色必須在角色名稱
AwsBackup
中包含AWSBackup
或。例如arn:aws:iam::123456789012:role/AWSBackupRDSAccess
。沒有這些字串的角色名稱,會缺乏執行備份作業的許可。類型:字串
必要:否
- InitiationDate
-
起始備份工作的日期。
類型:Timestamp
必要:否
- IsParent
-
此為布林值,表示這是父系 (複合) 備份作業。
類型:布林值
必要:否
- MessageCategory
-
此參數是指定訊息類別的任務計數。
範例字串可能包括
AccessDenied
、SUCCESS
、AGGREGATE_ALL
和INVALIDPARAMETERS
。如需 MessageCategory 字串清單,請參閱監視。該值ANY返回所有消息類別的計數。
AGGREGATE_ALL
彙總所有訊息類別的任務計數,並傳回總和。類型:字串
必要:否
- ParentJobId
-
這可唯一識別要 AWS Backup 備份資源的請求。傳回的值將是父系 (複合) 作業 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 彈性區塊存放區 (AmazonEBS) 磁碟區或 Amazon Relational Database Service 服務 (AmazonRDS) 資料庫。對於 Windows 磁碟區陰影複製服務 (VSS) 備份,唯一支援的資源類型是 Amazon EC2。
類型:String
模式:
^[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
-
說明備份資源之作業狀態的詳細訊息。
類型:字串
必要:否
另請參閱
如需API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: