取得分割區還原進度

發行項
08/04/2023

取得為此分割區觸發的最新還原作業詳細資料。

傳回最新還原作業狀態的相關資訊，以及完成時的詳細資料或失敗原因。

要求

方法	要求 URI
GET	`/Partitions/{partitionId}/$/GetRestoreProgress?api-version=6.4&timeout={timeout}`

參數

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

`partitionId`

類型：字串 (uuid)
必要：是

分割區的識別。

`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 狀態碼和還原進度詳細資料。	RestoreProgressInfo
所有其他狀態碼	詳細的錯誤回應。	FabricError

範例

取得還原作業進度

這會顯示 GetPartitionRestoreProgress 達到 RestoreState 為 Success 時的可能輸出範例。如果 RestoreState 的值為 RestoreInProgress，則只有 RestoreState 欄位會有值。

要求

GET http://localhost:19080/Partitions/1daae3f5-7fd6-42e9-b1ba-8c05f873994d/$/GetRestoreProgress?api-version=6.4

200 回應

主體

{
  "RestoreState": "Success",
  "TimeStampUtc": "2018-01-01T09:00:55Z",
  "RestoredEpoch": {
    "DataLossVersion": "131462452931584510",
    "ConfigurationVersion": "8589934592"
  },
  "RestoredLsn": "261",
  "FailureError": null
}

共用方式為