次の方法で共有

ポリシーを使用してクラスターの正常性を取得する

  • [アーティクル]

指定したポリシーを使用して Service Fabric クラスターの正常性を取得します。

正常性状態に基づいてクラスターで報告される正常性イベントのコレクションをフィルター処理するには、EventsHealthStateFilter を使用します。 同様に、集計された正常性の状態に基づいて返されるノードとアプリケーションのコレクションをフィルターするには、NodesHealthStateFilter と ApplicationsHealthStateFilter を使用します。 ClusterHealthPolicies を使用して、正常性の評価に使用される正常性ポリシーをオーバーライドします。

Request

Method 要求 URI
POST /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
NodesHealthStateFilter 整数 (integer) いいえ クエリ
ApplicationsHealthStateFilter 整数 (integer) いいえ クエリ
EventsHealthStateFilter 整数 (integer) いいえ クエリ
ExcludeHealthStatistics boolean いいえ クエリ
IncludeSystemApplicationHealthStatistics boolean いいえ クエリ
timeout integer (int64) いいえ クエリ
ClusterHealthPolicies ClusterHealthPolicies いいえ 本文

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 バージョンに従います。

NodesHealthStateFilter

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

正常性状態に基づくクラスター正常性クエリの結果で返されるノード正常性状態オブジェクトのフィルター処理を可能にします。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するノードのみが返されます。 すべてのノードが集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 '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 です。

ApplicationsHealthStateFilter

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

正常性状態に基づくクラスター正常性クエリの結果で返されるアプリケーション正常性状態オブジェクトのフィルター処理を可能にします。 このパラメーターに指定可能な値には、HealthStateFilter 列挙型のメンバーまたはメンバーのビットごとの演算から取得した整数値が含まれます。 フィルターに一致するアプリケーションのみが返されます。 集計された正常性の状態を評価するには、すべてのアプリケーションが使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 '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 です。

EventsHealthStateFilter

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

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

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

ExcludeHealthStatistics

型: ブール値
必須: いいえ
既定値:

正常性の統計情報をクエリ結果の一部として返すかどうかを示します。 既定では false です。 統計情報は、正常性の状態が Ok、Warning、および Error の子エンティティの数を示します。

IncludeSystemApplicationHealthStatistics

型: ブール値
必須: いいえ
既定値:

正常性の統計情報を fabric:/System アプリケーション正常性統計に含めるかどうかを示します。 既定では false です。 IncludeSystemApplicationHealthStatistics が true に設定されている場合、正常性の統計情報には fabric:/System アプリケーションに属しているエンティティが含まれます。 そうでない場合、クエリの結果には、ユーザー アプリケーションのみの正常性の統計情報が含まれます。 このパラメーターを適用するには、クエリの結果に正常性の統計情報が含まれている必要があります。

timeout

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

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

ClusterHealthPolicies

種類: ClusterHealthPolicies
必須: いいえ

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

応答

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