GetBackupPlan
返回指定 BackupPlan
的 BackupPlanId
详细信息。详细信息包含 JSON 格式的备份计划正文以及计划元数据。
请求语法
GET /backup/plans/backupPlanId
/?versionId=VersionId
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- backupPlanId
-
唯一标识备份计划。
必需:是
- VersionId
-
唯一的、随机生成的、Unicode、UTF-8 编码字符串,长度最大为 1024 个字节。无法编辑版本 ID。
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"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"
},
"RuleId": "string",
"RuleName": "string",
"ScheduleExpression": "string",
"ScheduleExpressionTimezone": "string",
"StartWindowMinutes": number,
"TargetBackupVaultName": "string"
}
]
},
"BackupPlanArn": "string",
"BackupPlanId": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"DeletionDate": number,
"LastExecutionDate": number,
"VersionId": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- AdvancedBackupSettings
-
包含每种资源的
BackupOptions
列表。仅在为备份计划设置高级选项时,才会填充该列表。类型:AdvancedBackupSetting 对象数组
- BackupPlan
-
指定备份计划的正文。包括
BackupPlanName
和一组或多组Rules
。类型:BackupPlan 对象
- 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。类型:时间戳
- CreatorRequestId
-
唯一字符串,用于标识请求并允许重试失败的请求,同时避免发生两次运行操作的风险。
类型:字符串
- DeletionDate
-
备份计划的删除日期和时间,采用 Unix 格式和协调世界时 (UTC)。
DeletionDate
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- LastExecutionDate
-
上次运行此备份计划的时间。日期和时间,采用 Unix 格式和协调世界时 (UTC)。
LastExecutionDate
的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- VersionId
-
唯一的、随机生成的、Unicode、UTF-8 编码字符串,长度最大为 1024 个字节。无法编辑版本 ID。
类型:字符串
错误
有关所有操作返回的常见错误的信息,请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出了范围。
HTTP 状态代码:400
- MissingParameterValueException
-
表示缺少必需的参数。
HTTP 状态代码:400
- ResourceNotFoundException
-
该操作所需的资源不存在。
HTTP 状态代码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP 状态代码:500
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: