CreateBackupPlan - AWS Backup

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean } } ], "EnableContinuousBackup": boolean, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "RecoveryPointTags": { "string" : "string" }, "RuleName": "string", "ScheduleExpression": "string", "ScheduleExpressionTimezone": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "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

资源类型的 BackupOptions 设置列表。此选项仅适用于 Windows 卷影复制服务 (VSS) 备份作业。

类型:AdvancedBackupSetting 对象数组

BackupPlanArn

唯一标识备份计划的 Amazon 资源名称 (ARN);例如,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50

类型:字符串

BackupPlanId

唯一标识备份计划。

类型:字符串

CreationDate

备份计划的创建日期和时间,采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

VersionId

唯一的、随机生成的、Unicode、UTF-8 编码字符串,长度最大为 1024 个字节。无法对其进行编辑。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

AlreadyExistsException

所需的资源已存在。

HTTP 状态代码:400

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

LimitExceededException

已超过请求中的限制;例如,请求中允许的最大项目数。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: