ポリシーを使用してレプリカの正常性を取得する

指定したポリシーを使用Service Fabricステートフル サービス レプリカまたはステートレス サービス インスタンスの正常性を取得します。

Service Fabric ステートフル サービス レプリカまたはステートレス サービス インスタンスの正常性を取得します。 正常性状態に基づいてクラスターで報告される正常性イベントのコレクションをフィルター処理するには、EventsHealthStateFilter を使用します。 ApplicationHealthPolicy を使用して、正常性の評価に使用される正常性ポリシーを必要に応じてオーバーライドします。 この API では、ApplicationHealthPolicy の 'ConsiderWarningAsError' フィールドのみを使用します。 残りのフィールドは、レプリカの正常性の評価中に無視されます。

Request

Method 要求 URI
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

パラメーター

名前 種類 必須 場所
partitionId string (UUID) はい Path
replicaId string はい Path
api-version string はい クエリ
EventsHealthStateFilter 整数 (integer) いいえ クエリ
timeout integer (int64) いいえ クエリ
ApplicationHealthPolicy ApplicationHealthPolicy いいえ 本文

partitionId

種類: string (uuid)
必須: はい

パーティションの ID。


replicaId

: string
必須: はい

レプリカの識別子。


api-version

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

API のバージョン。 このパラメーターは必須であり、その値は '6.0' である必要があります。

Service FabricREST APIは、API が導入または変更されたランタイム バージョンに基づいて作成されます。 Service Fabricは、複数のバージョンの API をサポートしています。 これは、サポートされている最新バージョンの API です。 より低い API バージョンが渡された場合、返される応答は、この仕様に記載されている応答とは異なる場合があります。

さらに、ランタイムは、現在のバージョンのランタイムまで、サポートされている最新バージョンより高いバージョンを受け入れる。 そのため、最新の API バージョンが 6.0 で、ランタイムが 6.1 の場合、クライアントの記述を容易にするために、ランタイムは、その API のバージョン 6.1 を受け入れる予定です。 ただし、API の動作は、ドキュメントに記載されている 6.0 バージョンに記載されている通りになります。


EventsHealthStateFilter

: 整数
必須: いいえ
既定値: 0

正常性の状態に基づいて返された HealthEvent オブジェクトのコレクションをフィルター処理できます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するイベントのみが返されます。 すべてのイベントが集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 'OR' を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のすべてのイベントが返されます。

  • 既定値 - 既定値。 任意の HealthState と一致します。 値は 0 です。
  • None - HealthState 値と一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。
  • [OK] - HealthState 値が OK の入力と一致するフィルター。 値は 2 です。
  • 警告 - HealthState 値 Warning の入力と一致するフィルター。 値は 4 です。
  • エラー - HealthState 値 Error の入力と一致するフィルター。 値は 8 です。
  • [すべて] - 入力と任意の HealthState 値を一致させるフィルター。 値は 65535 です。

timeout

: 整数 (int64)
必須: いいえ
既定値: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

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


ApplicationHealthPolicy

種類: ApplicationHealthPolicy
必須: いいえ

アプリケーションまたは子の 1 つの正常性を評価するために使用される正常性ポリシーについて説明します。 存在しない場合、正常性評価では、アプリケーション マニフェストまたは既定の正常性ポリシーの正常性ポリシーが使用されます。

応答

HTTP 状態コード [説明] 応答スキーマ
200 (OK) 操作が成功すると、200 状態コードと要求されたレプリカの正常性情報が返されます。
ReplicaHealth
その他のすべての状態コード 詳細なエラー応答。
FabricError