共用方式為

取得應用程式備份組態資訊

  • 發行項

取得 Service Fabric 應用程式備份組態資訊。

取得應用程式的 Service Fabric 備份組態資訊，以及此應用程式下的服務和分割區。

要求

方法 要求 URI
GET /Applications/{applicationId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

參數

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

applicationId

類型：字串
必要：是

應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層的名稱會以 "~" 字元分隔。 例如，如果應用程式名稱是 "fabric:/myapp/app1"，則應用程式識別在 6.0+ 中會是 "myapp~app1"，而在舊版中會是 "myapp/app1"。

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 版本。

ContinuationToken

類型：字串
必要：否

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

MaxResults

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

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

timeout

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

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

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) 成功的作業會傳回 200 狀態碼和應用程式的備份組態資訊分頁清單，以及此應用程式下的服務和分割區，其中已覆寫備份組態。
 PagedBackupConfigurationInfoList
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

限制最大結果

此範例示範如何取得此應用程式與實體的備份組態清單， (服務和分割區) 在此應用程式下。 頁面的結果數目限制為最多兩個使用 MaxResult 參數。

要求

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2

200 回應

主體
{
  "ContinuationToken": "fabric:/CalcApp/CalcService",
  "Items": [
    {
      "Kind": "Application",
      "PolicyName": "BackupPolicy1",
      "PolicyInheritedFrom": "Application",
      "ApplicationName": "fabric:/CalcApp",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    },
    {
      "Kind": "Service",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Service",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    }
  ]
}

使用接續權杖的頁面

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

要求

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService&MaxResults=2

200 回應

主體
{
  "ContinuationToken": "",
  "Items": [
    {
      "Kind": "Partition",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Service",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
      "SuspensionInfo": {
        "IsSuspended": true,
        "SuspensionInheritedFrom": "Partition"
      }
    }
  ]
}