本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CreateBackupPlan
使用備份計畫名稱和備份規則建立備份計畫。備份計劃是一種文件,其中包含 AWS Backup 使用 來排程建立資源復原點之任務的資訊。
如果呼叫 CreateBackupPlan 已經存在的計畫,您會收到 AlreadyExistsException 例外。
請求語法
PUT /backup/plans/ HTTP/1.1
Content-type: application/json
{
"BackupPlan": {
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanName": "string",
"Rules": [
{
"CompletionWindowMinutes": number,
"CopyActions": [
{
"DestinationBackupVaultArn": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"DeleteAfterEvent": "string",
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
}
}
],
"EnableContinuousBackup": boolean,
"IndexActions": [
{
"ResourceTypes": [ "string" ]
}
],
"Lifecycle": {
"DeleteAfterDays": number,
"DeleteAfterEvent": "string",
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string" : "string"
},
"RuleName": "string",
"ScanActions": [
{
"MalwareScanner": "string",
"ScanMode": "string"
}
],
"ScheduleExpression": "string",
"ScheduleExpressionTimezone": "string",
"StartWindowMinutes": number,
"TargetBackupVaultName": "string",
"TargetLogicallyAirGappedBackupVaultArn": "string"
}
],
"ScanSettings": [
{
"MalwareScanner": "string",
"ResourceTypes": [ "string" ],
"ScannerRoleArn": "string"
}
]
},
"BackupPlanTags": {
"string" : "string"
},
"CreatorRequestId": "string"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- BackupPlan
-
備份計畫的內文。包括一個
BackupPlanName和一或多組Rules。類型:BackupPlanInput 物件
必要:是
- BackupPlanTags
-
要指派給備份計劃的標籤。
類型:字串到字串映射
必要:否
- CreatorRequestId
-
可識別請求且允許重試失敗的請求,而不會有兩次執行操作的風險。如果請求包含符合現有備份計畫的
CreatorRequestId,則會傳回該計畫。此為選用參數。如果使用,此參數必須包含 1 至 50 個英數字元或 '-_'。字元。
類型:字串
必要:否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanArn": "string",
"BackupPlanId": "string",
"CreationDate": number,
"VersionId": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AdvancedBackupSettings
-
資源類型的設定。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份任務。
類型:AdvancedBackupSetting 物件陣列
- BackupPlanArn
-
可唯一識別備份計畫的 Amazon Resource Name (ARN),例如
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50。類型:字串
- BackupPlanId
-
備份計畫的 ID。
類型:字串
- CreationDate
-
建立備份計畫時的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。
CreationDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- VersionId
-
唯一隨機產生的 Unicode、UTF-8 編碼字串,最長 1,024 個位元組。您無法對其進行編輯。
類型:字串
錯誤
如需所有動作常見的錯誤資訊,請參閱《常見錯誤》。
- AlreadyExistsException
-
所需資源已存在。
- Arn
- Context
- CreatorRequestId
- Type
HTTP 狀態碼:400
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
- Context
- Type
HTTP 狀態碼:400
- LimitExceededException
-
請求已超過限制;例如,請求中允許的最大項目數量。
- Context
- Type
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
- Context
- Type
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
- Context
- Type
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: