共用方式為

從備份位置取得備份

  • 發行項

取得指定備份位置上所指定備份實體可用的備份清單。

取得指定備份實體 (應用程式、服務或分割區) 之指定備份位置 (FileShare 或Azure Blob 儲存體) 的備份清單。

要求

方法 要求 URI
POST /BackupRestore/$/GetBackups?api-version=6.4&timeout={timeout}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

參數

名稱 類型 必要 Location
api-version 字串 是 查詢
timeout 整數 (int64) No 查詢
ContinuationToken 字串 No 查詢
MaxResults 整數 (int64) No 查詢
GetBackupByStorageQueryDescription GetBackupByStorageQueryDescription 是 body

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 秒。

ContinuationToken

類型：字串
必要：否

接續權杖參數可用來取得下一組結果。 當來自系統的結果無法放入單一回應中時，API 的回應中會包含具有非空白值的接續權杖。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有任何進一步的結果，接續權杖就不會包含值。 此參數的值不能經過 URL 編碼。

MaxResults

類型：整數 (int64)
必要：否
預設：0
InclusiveMinimum： 0

分頁式查詢時傳回的最大結果數目。 此參數定義傳回結果數目的上限。 根據設定中所定義的訊息大小限制上限，如果所傳回的結果無法放入訊息中，則它們可以小於指定的結果上限。 如果此參數為零或未指定，則分頁式查詢會在傳回訊息中盡可能包含較多結果。

GetBackupByStorageQueryDescription

類型： GetBackupByStorageQueryDescription
必要：是

描述要用於列舉備份的篩選和備份儲存體詳細資料。

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) 成功的作業會傳回 200 狀態碼和分頁的備份資訊清單。
 PagedBackupInfoList
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

限制最大結果

此範例示範如何從指定的備份位置取得應用程式備份清單。 頁面中的結果數目限制為使用 MaxResult 參數最多兩個。

要求

POST http://localhost:19080/BackupRestore/$/GetBackups?api-version=6.4&MaxResults=2
主體
{
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "BackupEntity": {
    "EntityKind": "Application",
    "ApplicationName": "fabric:/CalcApp"
  }
}

200 回應

主體
{
  "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
  "Items": [
    {
      "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "261",
      "CreationTimeUtc": "2018-01-01T09:00:55Z",
      "FailureError": null
    },
    {
      "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "446",
      "CreationTimeUtc": "2018-01-01T17:01:02Z",
      "FailureError": null
    }
  ]
}

使用接續權杖的頁面

此範例示範如何取得應用程式備份的清單。 頁面中的結果數目限制為使用 MaxResult 參數最多兩個。 此範例使用 ContinuationToken 參數。 此參數的值是從上一個查詢提供;在此案例中，如上所示的範例。 回應包含剩餘的結果和空的 ContinuationToken。 空的 ContinuationToken 表示無法使用其他結果。

要求

POST http://localhost:19080/BackupRestore/$/GetBackups?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd&MaxResults=2
主體
{
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "BackupEntity": {
    "EntityKind": "Application",
    "ApplicationName": "fabric:/CalcApp"
  }
}

200 回應

主體
{
  "ContinuationToken": "",
  "Items": [
    {
      "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "161",
      "CreationTimeUtc": "2018-01-01T09:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "246",
      "CreationTimeUtc": "2018-01-01T17:00:34Z",
      "FailureError": null
    }
  ]
}