ノード切り替えの進行状況を取得する

  • [アーティクル]

StartNodeTransition を使用して開始された操作の進行状況を取得します。

指定された OperationId を使用して、StartNodeTransition で開始された操作の進行状況を取得します。

Request

Method 要求 URI
GET /Faults/Nodes/{nodeName}/$/GetTransitionProgress?api-version=6.0&OperationId={OperationId}&timeout={timeout}

パラメーター

名前 Type 必須 場所
nodeName string はい パス
api-version string はい クエリ
OperationId string (UUID) はい クエリ
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 に渡されます

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) ノード切り替え操作の進行状況に関する情報。
 NodeTransitionProgress
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

完了した NodeTransition 操作に関する情報を取得します

これは、GetTransitionProgress が完了状態に達したときに発生する可能性のある出力の例を示しています。 State の値が Running の場合、State フィールドにのみ値が設定されます。

要求

GET http://localhost:19080/Faults/Nodes/N0060/$/GetTransitionProgress?api-version=6.0&OperationId=a9c24269-88e9-4812-b4ad-a0bf2b724ad4

200 応答

本文
{
  "State": "Completed",
  "NodeTransitionResult": {
    "ErrorCode": "0",
    "NodeResult": {
      "NodeName": "N0060",
      "NodeInstanceId": "131366982707950527"
    }
  }
}

実行中の NodeTransition 操作に関する情報を取得します

これは、GetTransitionProgress に [実行中の状態] がある場合の出力の例を示しています。

要求

GET http://localhost:19080/Faults/Nodes/N0060/$/GetTransitionProgress?api-version=6.0&OperationId=ed903556-acf1-489c-9f33-b484c31f9087

200 応答

本文
{
  "State": "Running"
}