データ損失の進行状況を取得する

  • [アーティクル]

StartDataLoss API を使用して開始されたパーティション データ損失操作の進行状況を取得します。

OperationId を使用して、StartDataLoss で開始されたデータ損失操作の進行状況を取得します。

Request

Method 要求 URI
GET /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress?api-version=6.0&OperationId={OperationId}&timeout={timeout}

パラメーター

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

serviceId

型: string
必須: はい

サービスの ID。 この ID は通常、"fabric:" URI スキームのないサービスの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、6.0 以上ならばサービス ID は "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。

partitionId

型: string (uuid)
必須: はい

パーティションの ID。

api-version

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

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

型: string (uuid)
必須: はい

この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) パーティション データ損失操作の進行状況に関する情報。
 PartitionDataLossProgress
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

パーティション データ損失操作に関する情報を取得します。 この場合、操作の状態は完了です

これは、GetDataLossProgress が完了状態に達したときに発生する可能性のある出力の例を示しています。 State の値が Running の場合、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 の値が Running の場合、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"
}