本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
GetBackupPlan
傳回指定 BackupPlanId 的 BackupPlan 詳細資訊。詳細資料是 JSON 格式的備份計畫內文,並包括計畫中繼資料。
請求語法
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- backupPlanId
- 
               唯一識別備份計畫。 必要:是 
- MaxScheduledRunsPreview
- 
               要預覽的未來排程備份執行數目。設為 0 (預設) 時,回應中不會包含排程執行預覽。有效範圍為 0-10。 有效範圍:最小值為 0。最大值為 10。 
- VersionId
- 
               唯一隨機產生的 Unicode、UTF-8 編碼字串,最長 1,024 個位元組。版本 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,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "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,
   "ScheduledRunsPreview": [ 
      { 
         "ExecutionTime": number,
         "RuleExecutionType": "string",
         "RuleId": "string"
      }
   ],
   "VersionId": "string"
}回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AdvancedBackupSettings
- 
               包含每種資源類型的 BackupOptions清單。只有在為備份計畫設定進階選項時,才會填入清單。類型:AdvancedBackupSetting 物件陣列 
- BackupPlan
- 
               指定備份計畫的內文。包括一個 BackupPlanName和一或多組Rules。類型:BackupPlan 物件 
- BackupPlanArn
- 
               可唯一識別備份計畫的 Amazon Resource Name (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 秒。類型:Timestamp 
- CreatorRequestId
- 
               可識別請求的唯一字串,且允許重試失敗的請求,而不會有兩次執行操作的風險。 類型:字串 
- DeletionDate
- 
               刪除備份計畫時的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。 DeletionDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp 
- LastExecutionDate
- 
               上次執行此備份計畫的時間。日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。 LastExecutionDate的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp 
- ScheduledRunsPreview
- 
               即將排程備份執行的清單。僅在 MaxScheduledRunsPreview參數大於 0 時包含。包含最多 10 個未來的備份執行,其中包含其排程時間、執行類型和相關聯的規則 IDs。類型:ScheduledPlanExecutionMember 物件陣列 
- VersionId
- 
               唯一隨機產生的 Unicode、UTF-8 編碼字串,最長 1,024 個位元組。版本 ID 不能編輯。 類型:字串 
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
- 
               表示參數的值出現問題。例如,值超出範圍。 - Context
- Type
 HTTP 狀態碼:400 
- MissingParameterValueException
- 
               表示缺少必要的參數。 - Context
- Type
 HTTP 狀態碼:400 
- ResourceNotFoundException
- 
               動作所需的資源不存在。 - Context
- Type
 HTTP 狀態碼:400 
- ServiceUnavailableException
- 
               由於伺服器發生臨時故障,請求失敗。 - Context
- Type
 HTTP 狀態碼:500 
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: