ノード遷移の開始

  • [アーティクル]

クラスター ノードを開始または停止します。

クラスター ノードを開始または停止します。 クラスター ノードはプロセスで、OS インスタンスそのものではありません。 ノードを開始するには、NodeTransitionType パラメーターに "Start" を渡します。 ノードを停止するには、NodeTransitionType パラメーターに "Stop" を渡します。 この API は、移行がまだ完了していない可能性のあるノードを API が返したときに操作を開始します。 操作の進行状況を取得するには、同じ OperationId を使用して GetNodeTransitionProgress を呼び出します。

Request

Method 要求 URI
POST /Faults/Nodes/{nodeName}/$/StartTransition/?api-version=6.0&OperationId={OperationId}&NodeTransitionType={NodeTransitionType}&NodeInstanceId={NodeInstanceId}&StopDurationInSeconds={StopDurationInSeconds}&timeout={timeout}

パラメーター

名前 Type 必須 場所
nodeName string はい パス
api-version string はい クエリ
OperationId string (UUID) はい クエリ
NodeTransitionType string (enum) はい クエリ
NodeInstanceId string はい クエリ
StopDurationInSeconds integer (int32) はい クエリ
timeout integer (int64) いいえ クエリ

nodeName

型: string
必須: はい

ノード名。

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

NodeTransitionType

型: string (enum)
必須: はい

実行する移行の種類を示します。 NodeTransitionType.Start は、停止したノードを開始します。 NodeTransitionType.Stop は、稼働しているノードを停止します。 指定できる値は、'Invalid'、'Start'、'Stop' です。

NodeInstanceId

型: string
必須: はい

ターゲット ノードのノード インスタンス ID。 これは GetNodeInfo API を通じて決定できます。

StopDurationInSeconds

型: integer (int32)
必須: はい
InclusiveMinimum: 0

ノードを停止させたままにする期間 (秒単位)。 最小値は 600、最大値は 14400 です。 この時間を過ぎると、ノードは自動的に復帰します。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
202 (承認済み) 202 状態コードは、操作が受け入れられたかどうかを示します。 GetNodeTransitionProgress API を呼び出して進行状況を取得します。
その他のすべての状態コード 詳細なエラー応答。
 FabricError