パーティションの復元の進行状況を取得する

[アーティクル]
07/19/2023

このパーティションに対してトリガーされた最新の復元操作の詳細を取得します。

完了した場合の詳細またはエラーの理由と共に、最新の復元操作の状態に関する情報を返します。

Request

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

パラメーター

名前	Type	必須	場所
`partitionId`	string (UUID)	はい	パス
`api-version`	string	はい	クエリ
`timeout`	integer (int64)	いいえ	クエリ

`partitionId`

型: string (uuid)
必須: はい

パーティションの ID。

`api-version`

型: string
必須: はい
既定値:

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`

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバータイムアウト (秒単位)。このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。このパラメーターの既定値は 60 秒です。

応答

HTTP 状態コード	説明	応答スキーマ
200 (OK)	操作が成功すると、200 の状態コードが返され、進行状況の詳細が復元されます。	RestoreProgressInfo
その他のすべての状態コード	詳細なエラー応答。	FabricError

使用例

復元操作の進行状況を取得する

これは、GetPartitionRestoreProgress が RestoreState of 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
}

次の方法で共有