取得資料遺失進度
針對使用 StartDataLoss API 啟動的分割區資料遺失作業,取得作業的進度。
針對使用 StartDataLoss API 啟動的資料遺失作業,以 OperationId 來取得作業的進度。
要求
方法 | 要求 URI |
---|---|
GET | /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress?api-version=6.0&OperationId={OperationId}&timeout={timeout} |
參數
名稱 | 類型 | 必要 | Location |
---|---|---|---|
serviceId |
字串 | 是 | 路徑 |
partitionId |
字串 (uuid) | 是 | 路徑 |
api-version |
字串 | 是 | 查詢 |
OperationId |
字串 (uuid) | 是 | 查詢 |
timeout |
整數 (int64) | No | 查詢 |
serviceId
類型:字串
必要:是
服務的身分識別。 此識別碼通常是不含 'fabric:' URI 配置的服務完整名稱。
從 6.0 版開始,階層的名稱會以 "~" 字元分隔。
例如,如果服務名稱是 "fabric:/myapp/app1/svc1",那麼在 6.0 以上的版本中,服務識別為 "myapp~app1~svc1",在舊版中則為 "myapp/app1/svc1"。
partitionId
類型:字串 (uuid)
必要:是
分割區的識別。
api-version
類型:字串
必要:是
預設:6.0
API 的版本。 這是必要參數,其值必須是 '6.0'。
Service Fabric REST API 版本是以 API 引進或變更的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。 這是 API 的最新支援版本。 如果傳遞較低的 API 版本,傳回的回應可能會與本規格中所述的回應不同。
此外,執行時間也接受高於最新支援版本的任何版本,最高為目前版本的執行時間。 因此,如果最新的 API 版本是 6.0,但如果執行時間是 6.1,為了更容易撰寫用戶端,執行時間將會接受該 API 6.1 版。 不過,API 的行為會根據記載的 6.0 版本。
OperationId
類型:字串 (uuid)
必要:是
識別此 API 呼叫的 GUID。 這會傳入對應的 GetProgress API
timeout
類型:整數 (int64)
必要:否
預設:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。
回應
HTTP 狀態碼 | 描述 | 回應結構描述 |
---|---|---|
200 (確定) | 資料分割資料遺失作業進度的相關資訊。 |
PartitionDataLossProgress |
所有其他狀態碼 | 詳細的錯誤回應。 |
FabricError |
範例
取得資料分割資料遺失作業的相關資訊。 在此情況下,作業的狀態為已完成
這會顯示 GetDataLossProgress 達到已完成狀態時可能輸出的範例。 如果 State 的值是 [正在執行],則只有 [狀態] 欄位會有值。
要求
GET http://localhost:19080/Faults/Services/fabric:/myapp/myservice/$/GetPartitions/1daae3f5-7fd6-42e9-b1ba-8c05f873994d/$/GetDataLossProgress?api-version=6.0&OperationId=7216486c-1ee9-4b00-99b2-92b26fcb07f5
200 回應
主體
{
"State": "Completed",
"InvokeDataLossResult": {
"ErrorCode": "0",
"SelectedPartition": {
"ServiceName": "fabric:/myapp/myservice",
"PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
}
}
}
取得資料分割資料遺失作業的相關資訊。 在此情況下,作業是執行中的狀態
這會顯示當資料遺失作業處於執行中狀態時的輸出範例。 如果 State 的值是 [正在執行],則只有 [狀態] 欄位會有值。
要求
GET http://localhost:19080/Faults/Services/fabric:/myapp/myservice/$/GetPartitions/1daae3f5-7fd6-42e9-b1ba-8c05f873994d/$/GetDataLossProgress?api-version=6.0&OperationId=7216486c-1ee9-4b00-99b2-92b26fcb07f5
200 回應
主體
{
"State": "Running"
}