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

指定したポリシーを使用して、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}

パラメーター

名前 Type 必須 場所
partitionId string (UUID) はい パス
replicaId string はい パス
api-version string はい クエリ
EventsHealthStateFilter 整数 (integer) いいえ クエリ
timeout integer (int64) いいえ クエリ
ApplicationHealthPolicy ApplicationHealthPolicy いいえ Body

partitionId

: 文字列 (uuid)
必須: はい

パーティションの ID。


replicaId

: 文字列
必須: はい

レプリカの識別子。


api-version

: 文字列
必須: はい
既定値:

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

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

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


EventsHealthStateFilter

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

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

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

timeout

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

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


ApplicationHealthPolicy

: ApplicationHealthPolicy
必須: いいえ

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

応答

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