ポリシーと高度なフィルターを使用してクラスター正常性チャンクを取得する

  • [アーティクル]

正常性チャンクを使用して Service Fabric クラスターの正常性を取得します。

正常性チャンクを使用して Service Fabric クラスターの正常性を取得します。 正常性評価は、入力クラスターの正常性チャンク クエリの説明に基づいて行われます。 クエリの説明を使用すると、ユーザーはクラスターとその子を評価するための正常性ポリシーを指定できます。 ユーザーは非常に柔軟なフィルターを指定して、返すクラスター エンティティを選択できます。 選択は、エンティティの正常性状態と階層に基づいて行うことができます。 クエリは、指定されたフィルターに基づいてエンティティの複数レベルの子を返すことができます。 たとえば、指定した名前の 1 つのアプリケーションを返すことができます。このアプリケーションでは、Error または Warning に含まれるサービスと、これらのサービスの 1 つのすべてのパーティションとレプリカのみを返します。

Request

Method 要求 URI
POST /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
timeout integer (int64) いいえ クエリ
ClusterHealthChunkQueryDescription ClusterHealthChunkQueryDescription いいえ 本文

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

timeout

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

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

ClusterHealthChunkQueryDescription

種類: ClusterHealthChunkQueryDescription
必須: いいえ

クラスターの正常性を評価するために使用されるクラスターとアプリケーションの正常性ポリシーと、返されるクラスター エンティティを選択するフィルターについて説明します。 クラスター正常性ポリシーが存在する場合は、クラスター イベントとクラスター ノードを評価するために使用されます。 存在しない場合、正常性評価では、クラスター マニフェストまたは既定のクラスター正常性ポリシーで定義されているクラスター正常性ポリシーが使用されます。 既定では、各アプリケーションは、アプリケーション マニフェストで定義されている特定のアプリケーション正常性ポリシー、またはマニフェストでポリシーが定義されていない場合は既定の正常性ポリシーを使用して評価されます。 アプリケーション正常性ポリシー マップが指定され、アプリケーションのエントリがある場合は、指定されたアプリケーション正常性ポリシーを使用してアプリケーションの正常性を評価します。 ユーザーは非常に柔軟なフィルターを指定して、応答に含めるクラスター エンティティを選択できます。 選択は、エンティティの正常性状態と階層に基づいて行うことができます。 クエリは、指定されたフィルターに基づいてエンティティの複数レベルの子を返すことができます。 たとえば、指定した名前の 1 つのアプリケーションを返すことができます。このアプリケーションでは、Error または Warning に含まれるサービスと、これらのサービスの 1 つのすべてのパーティションとレプリカのみを返します。

応答

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