本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # StartBackupJob 啟動指定資源的隨需備份任務。 ## 請求語法 ``` PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Index": "string", "Lifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "LogicallyAirGappedBackupVaultArn": "string", "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number } ``` ## URI 請求參數請求不會使用任何 URI 參數。 ## 請求主體請求接受採用 JSON 格式的下列資料。 ** [BackupOptions](#API_StartBackupJob_RequestSyntax) ** 所選資源的備份選項。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份作業。有效值：設定為 `"WindowsVSS":"enabled"` 即可啟用 `WindowsVSS` 備份選項，並建立 Windows VSS 備份。設定為 `"WindowsVSS""disabled"` 即可建立一般備份。`WindowsVSS` 選項預設為停用。類型：字串到字串映射金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` 值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$` 必要：否 ** [BackupVaultName](#API_StartBackupJob_RequestSyntax) ** 存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。類型：字串模式：`^[a-zA-Z0-9\-\_]{2,50}$` 必要：是 ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) ** 一個分鐘值，成功啟動的備份必須在此期間完成，否則 AWS Backup 將取消任務。此值是選用的。此值會從排程備份的時間開始倒數。其不會為 `StartWindowMinutes` 增加額外的時間，也不會因為備份比排程晚開始而增加時間。就像 `StartWindowMinutes`，這項參數的最大值為 100 年 (52,560,000 分鐘)。類型：Long 必要：否 ** [IamRoleArn](#API_StartBackupJob_RequestSyntax) ** 指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。類型：字串必要：是 ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) ** 客戶所選擇的字串，可用來區分在其他方面相同的 `StartBackupJob` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。類型：字串必要：否 ** [Index](#API_StartBackupJob_RequestSyntax) ** 如果您的備份任務具有支援備份索引的資源類型，請包含此參數以啟用索引建立。支援備份索引的資源類型包括： + `EBS` 代表 Amazon Elastic Block Store + `S3` for Amazon Simple Storage Service (Amazon S3) 索引可以有 2 個可能值中的 1 個，可以是 `ENABLED`或 `DISABLED`。若要為尚未擁有備份索引的合格`ACTIVE`復原點建立備份索引，請將值設定為 `ENABLED`。若要刪除備份索引，請將值設定為 `DISABLED`。類型：字串有效值:`ENABLED | DISABLED` 必要：否 ** [Lifecycle](#API_StartBackupJob_RequestSyntax) ** 生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 AWS Backup 會根據您定義的生命週期自動轉換和過期備份。轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。會 AWS Backup 忽略其他資源類型的此表達式。這項參數的最大值為 100 年 (36,500 天)。類型：[Lifecycle](API_Lifecycle.md) 物件必要：否 ** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) ** 邏輯氣隙隔離保存庫的 ARN。ARN 必須位於相同的帳戶和區域。如果提供，支援的全受管資源會直接備份到邏輯氣隙隔離保存庫，而其他支援的資源則會在備份保存庫中建立暫時（計費）快照，然後將其複製到邏輯氣隙隔離保存庫。不支援的資源只會備份到指定的備份保存庫。類型：字串必要：否 ** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) ** 要指派給資源的標籤。類型：字串到字串映射必要：否 ** [ResourceArn](#API_StartBackupJob_RequestSyntax) ** 可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。類型：字串必要：是 ** [StartWindowMinutes](#API_StartBackupJob_RequestSyntax) ** 從排程備份到取消任務 (如未成功啟動) 的分鐘值。此為選用值，預設為 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](#API_StartBackupJob_ResponseSyntax) ** 唯一識別 AWS Backup 對備份資源的請求。類型：字串 ** [CreationDate](#API_StartBackupJob_ResponseSyntax) ** 建立備份作業時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型：Timestamp ** [IsParent](#API_StartBackupJob_ResponseSyntax) ** 此為傳回的布林值，表示這是父系 (複合) 備份作業。類型：布林值 ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) ** *附註：只有 Amazon EFS 和進階 DynamoDB 資源才會傳回此欄位。* 可唯一識別復原點的 ARN；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。類型：字串 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。 ** InvalidParameterValueException ** 表示參數的值出現問題。例如，值超出範圍。 ** Context ** ** Type ** HTTP 狀態碼：400 ** InvalidRequestException ** 表示請求的輸入出現問題。例如，參數的類型錯誤。 ** Context ** ** Type ** HTTP 狀態碼：400 ** LimitExceededException ** 請求已超過限制；例如，請求中允許的最大項目數量。 ** 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/StartBackupJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob)