本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
StartBackupJob
啟動指定資源的隨需備份任務。
請求語法
PUT /backup-jobs HTTP/1.1
Content-type: application/json
{
"BackupOptions": {
"string" : "string"
},
"BackupVaultName": "string",
"CompleteWindowMinutes": number,
"IamRoleArn": "string",
"IdempotencyToken": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string" : "string"
},
"ResourceArn": "string",
"StartWindowMinutes": number
}URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- BackupOptions
-
所選資源的備份選項。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份作業。
有效值：設定為
"WindowsVSS":"enabled"即可啟用WindowsVSS備份選項，並建立 Windows VSS 備份。設定為"WindowsVSS""disabled"即可建立一般備份。WindowsVSS選項預設為停用。類型：字串到字串映射
金鑰模式：
^[a-zA-Z0-9\-\_\.]{1,50}$值模式：
^[a-zA-Z0-9\-\_\.]{1,50}$必要：否
- BackupVaultName
-
存放備份的邏輯容器的名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。這些名稱由小寫字母、數字和連字號組成。
類型：String
模式：
^[a-zA-Z0-9\-\_]{2,50}$必要：是
- CompleteWindowMinutes
-
一個分鐘值，成功啟動的備份必須在此期間完成，否則 AWS Backup 將取消任務。此值是選用的。此值會從排程備份的時間開始倒數。其不會為
StartWindowMinutes增加額外的時間，也不會因為備份比排程晚開始而增加時間。就像
StartWindowMinutes，這項參數的最大值為 100 年 (52,560,000 分鐘)。類型：Long
必要：否
- IamRoleArn
-
指定用來建立目標復原點的 IAM 角色 ARN；例如
arn:aws:iam::123456789012:role/S3Access。類型：字串
必要：是
- IdempotencyToken
-
客戶所選擇的字串，可用來區分在其他方面相同的
StartBackupJob呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。類型：字串
必要：否
- Lifecycle
-
生命週期定義受保護的資源何時轉換為冷存儲以及何時到期。 AWS Backup 將根據您定義的生命週期自動轉換備份並使備份過期。
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。「轉移至冷儲存前所需天數」設定在已有備份轉移至冷儲存後就無法再加以變更。
可轉換至冷藏的資源類型會列在「依資源分類的功能可用性」表格中。 AWS Backup 忽略其他資源類型的這個表示式。
這項參數的最大值為 100 年 (36,500 天)。
類型：Lifecycle 物件
必要：否
- RecoveryPointTags
-
要指派給資源的標籤。
類型：字串到字串映射
必要：否
- ResourceArn
-
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。
類型：字串
必要：是
- StartWindowMinutes
-
從排程備份到取消任務 (如未成功啟動) 的分鐘值。此為選用值，預設為 8 小時。若包含此值，則其必須至少為 60 分鐘以避免發生錯誤。
此參數的最大值為 100 年 (52,560,000 分鐘)。
在啟動時段期間，備份任務狀態會保持在
CREATED狀態，直到順利開始或啟動時段時間用完為止。如果在開始時段時間內 AWS Backup 收到允許重試工作的錯誤訊息，則 AWS Backup 會自動重試一次至少每 10 分鐘開始工作，直到備份成功開始 (工作狀態變更為RUNNING) 或工作狀態變更為EXPIRED(預期會在開始時段時間結束時發生)。類型：Long
必要：否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- BackupJobId
-
唯一識別備份 AWS Backup 資源的請求。
類型：字串
- CreationDate
-
建立備份作業時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。
CreationDate的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型：Timestamp
- IsParent
-
此為傳回的布林值，表示這是父系 (複合) 備份作業。
類型：布林值
- RecoveryPointArn
-
附註：只有 Amazon EFS 和進階 DynamoDB 資源才會傳回此欄位。
可唯一識別復原點的 ARN；例如
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45。類型：字串
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如，值超出範圍。
HTTP 狀態碼：400
- InvalidRequestException
-
表示請求的輸入出現問題。例如，參數的類型錯誤。
HTTP 狀態碼：400
- LimitExceededException
-
請求已超過限制；例如，請求中允許的最大項目數量。
HTTP 狀態碼：400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼：400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼：400
- ServiceUnavailableException
-
由於伺服器發生臨時故障，請求失敗。
HTTP 狀態碼：500
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
