取り消し操作

  • [アーティクル]

ユーザーが誘発したフォールト操作を取り消します。

StartDataLoss、StartQuorumLoss、StartPartitionRestart、StartNodeTransition の各 API は、CancelOperation を使用してキャンセルされた可能性のあるフォールト操作を開始できます。

force が false の場合、指定されたユーザーが誘発した操作は適切に停止され、クリーンアップされます。 force が true の場合、このコマンドは中止され、一部の内部状態は取り残される可能性があります。 force を true として指定する際は、注意してください。 force を true に設定した状態でこの API を呼び出すことは、最初に force を false に設定した状態で同じテスト コマンドに対してこの API の呼び出しが完了しているか、テスト コマンドで既に OperationState.RollingBack の OperationState が設定されていなければ許可されません。 説明: OperationState.RollingBack は、コマンドの実行によって生じた内部システム状態をシステムがクリーンアップすることを意味します。 テスト コマンドがデータ損失の原因だった場合、データは復元されません。 たとえば、StartDataLoss を呼び出した後にこの API を呼び出した場合、システムによってクリーンアップされるのは、コマンドの実行による内部状態のみです。 データ損失を引き起こすほどコマンドが進行した場合、対象パーティションのデータは復元されません。

重要な注意: この API は force==true を指定して呼び出した場合、内部状態は取り残される可能性があります。

Request

Method 要求 URI
POST /Faults/$/Cancel?api-version=6.0&OperationId={OperationId}&Force={Force}&timeout={timeout}

パラメーター

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

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 に渡されます

Force

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

ユーザーが誘発した操作の実行によって変更された内部システム状態を適切にロールバックしてクリーンアップするかどうかを示します。

timeout

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

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

応答

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