Share via

依名稱取得備份原則

  • 發行項

依名稱取得特定的備份原則。

取得 {backupPolicyName} 所識別的特定備份原則

要求

方法 要求 URI
GET /BackupRestore/BackupPolicies/{backupPolicyName}?api-version=6.4&timeout={timeout}

參數

名稱 類型 必要 Location
backupPolicyName 字串 是 路徑
api-version 字串 是 查詢
timeout 整數 (int64) No 查詢

backupPolicyName

類型：字串
必要：是

備份原則的名稱。

api-version

類型：字串
必要：是
預設：6.4

API 的版本。 這是必要參數，其值必須是 '6.4'。

Service Fabric REST API 版本是以導入或變更 API 的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。 此版本是 API 的最新支援版本。 如果傳遞較低的 API 版本，傳回的回應可能與此規格中所述的回應不同。

此外，執行時間會接受高於最新支援版本的任何版本，最高到目前版本的執行時間。 因此，如果最新的 API 版本為 6.0，且執行時間為 6.1，則執行時間將會接受該 API 的版本 6.1。 不過，API 的行為會根據記載的 6.0 版本。

timeout

類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) 成功的作業會傳回 200 狀態碼和備份原則描述。
 BackupPolicyDescription
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

依名稱取得備份原則

此範例示範如何依名稱查詢備份原則。

要求

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy?api-version=6.4

200 回應

主體
{
  "Name": "DailyAzureBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P20D"
  }
}