Obtenir l’intégrité du cluster à l’aide de la stratégie

Article
07/19/2023

Obtient l’intégrité d’un cluster Service Fabric à l’aide de la stratégie spécifiée.

EventsHealthStateFilter permet de filtrer la collecte d’événements de contrôle d’intégrité signalés sur le cluster en fonction de l’état d’intégrité. De même, utilisez NodesHealthStateFilter et ApplicationsHealthStateFilter pour filtrer la collection de nœuds et d’applications renvoyées en fonction de leur état d’intégrité agrégé. Utilisez ClusterHealthPolicies pour remplacer les stratégies d’intégrité utilisées pour évaluer l’intégrité.

Requête

Méthode	URI de demande
POST	`/$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`api-version`	string	Oui	Requête
`NodesHealthStateFilter`	entier	Non	Requête
`ApplicationsHealthStateFilter`	entier	Non	Requête
`EventsHealthStateFilter`	entier	Non	Requête
`ExcludeHealthStatistics`	boolean	Non	Requête
`IncludeSystemApplicationHealthStatistics`	boolean	Non	Requête
`timeout`	integer (int64)	Non	Requête
`ClusterHealthPolicies`	ClusterHealthPolicies	Non	body

`api-version`

Type : chaîne
Obligatoire : Oui
Par défaut : 6.0

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.0 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version inférieure de l’API est passée, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0, mais que le runtime est 6.1, afin de faciliter l’écriture des clients, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera conformément à la version 6.0 documentée.

`NodesHealthStateFilter`

Type : entier
Obligatoire : Non
Par défaut : 0

Permet de filtrer, par état d’intégrité, les objets d’état d’intégrité des nœuds qui sont retournés dans les résultats de la requête d’intégrité du cluster. Les valeurs possibles de ce paramètre incluent la valeur entière de l’un des états d’intégrité suivants. Seuls les nœuds qui correspondent au filtre sont renvoyés. Tous les nœuds sont utilisés pour évaluer l’état d’intégrité agrégé. Si cet argument n’est pas spécifié, toutes les entrées sont retournées. Les valeurs d’état sont une énumération basée sur des indicateurs. La valeur peut donc être une combinaison de ces valeurs obtenue à l’aide de l’opérateur « OR » au niveau du bit. Par exemple, si la valeur indiquée est 6, l’état d’intégrité des nœuds dont la valeur HealthState est OK (2) et Warning (4) est retourné.

Valeur par défaut : valeur par défaut. Correspond à toute valeur HealthState. La valeur est égale à zéro.
Aucun : filtre qui ne correspond à aucune valeur HealthState. Permet de ne retourner aucun résultat sur une collection donnée d’états. La valeur est égale à 1.
Ok : filtre qui correspond à l’entrée avec la valeur HealthState Ok. La valeur est égale à 2.
Avertissement : filtre qui correspond à l’entrée avec la valeur HealthState Warning. La valeur est égale à 4.
Erreur : filtre qui correspond à l’entrée avec la valeur HealthState Error. La valeur est égale à 8.
All : filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

`ApplicationsHealthStateFilter`

Type : entier
Obligatoire : Non
Par défaut : 0

Permet de filtrer, par état d’intégrité, les objets d’état d’intégrité des applications qui sont retournés dans les résultats de la requête d’intégrité du cluster. Les valeurs possibles pour ce paramètre incluent la valeur entière qui est obtenue à partir des membres ou des opérations au niveau du bit effectuées sur les membres de l’énumération HealthStateFilter. Seules les applications qui correspondent au filtre sont retournées. Toutes les applications sont utilisées pour évaluer l’état d’intégrité agrégé. Si cet argument n’est pas spécifié, toutes les entrées sont retournées. Les valeurs d’état sont une énumération basée sur des indicateurs. La valeur peut donc être une combinaison de ces valeurs obtenue à l’aide de l’opérateur « OR » au niveau du bit. Par exemple, si la valeur indiquée est 6, l’état d’intégrité des applications dont la valeur HealthState est OK (2) et Warning (4) est retourné.

Valeur par défaut : valeur par défaut. Correspond à toute valeur HealthState. La valeur est égale à zéro.
Aucun : filtre qui ne correspond à aucune valeur HealthState. Permet de ne retourner aucun résultat sur une collection donnée d’états. La valeur est égale à 1.
Ok : filtre qui correspond à l’entrée avec la valeur HealthState Ok. La valeur est égale à 2.
Avertissement : filtre qui correspond à l’entrée avec la valeur HealthState Warning. La valeur est égale à 4.
Erreur : filtre qui correspond à l’entrée avec la valeur HealthState Error. La valeur est égale à 8.
All : filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

`EventsHealthStateFilter`

Type : entier
Obligatoire : Non
Par défaut : 0

Permet de filtrer la collection d’objets HealthEvent retournés en fonction de leur état d’intégrité. Les valeurs possibles de ce paramètre incluent la valeur entière de l’un des états d’intégrité suivants. Seuls les événements qui correspondent au filtre sont renvoyés. Tous les événements sont utilisés pour évaluer l’état d’intégrité agrégé. Si cet argument n’est pas spécifié, toutes les entrées sont retournées. Les valeurs d’état correspondent à une énumération basée sur des indicateurs. La valeur peut donc être une combinaison de ces valeurs obtenue à l’aide de l’opérateur « OR » au niveau du bit. Par exemple, si la valeur indiquée est 6, tous les événements dont la valeur HealthState est OK (2) et Warning (4) sont retournés.

Valeur par défaut : valeur par défaut. Correspond à toute valeur HealthState. La valeur est égale à zéro.
None : filtre qui ne correspond à aucune valeur HealthState. Permet de ne retourner aucun résultat sur une collection donnée d’états. La valeur est égale à 1.
Ok : filtre qui correspond à l’entrée avec la valeur HealthState Ok. La valeur est égale à 2.
Avertissement : filtre qui correspond à l’entrée avec la valeur HealthState Warning. La valeur est égale à 4.
Erreur : filtre qui correspond à l’entrée avec la valeur HealthState Error. La valeur est égale à 8.
All : filtre qui correspond à une entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

`ExcludeHealthStatistics`

Type : booléen
Obligatoire : Non
Par défaut : false

Indique si les statistiques d’intégrité doivent être retournées dans le cadre du résultat de la requête. False par défaut. Les statistiques affichent le nombre d’entités enfants dont l’état d’intégrité est OK, Warning et Error.

`IncludeSystemApplicationHealthStatistics`

Type : booléen
Obligatoire : Non
Par défaut : false

Indique si les statistiques d’intégrité doivent inclure celles des applications fabric:/System. False par défaut. Si IncludeSystemApplicationHealthStatistics est défini sur true, les statistiques d’intégrité des statistiques incluent les entités qui appartiennent à l’application fabric:/System. Dans le cas contraire, le résultat de la requête inclut uniquement les statistiques d’intégrité pour les applications utilisateur. Pour que ce paramètre soit appliqué, les statistiques d’intégrité doivent être incluses dans le résultat de la requête.

`timeout`

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

`ClusterHealthPolicies`

Type : ClusterHealthPolicies
Obligatoire : Non

Décrit les stratégies d’intégrité utilisées pour évaluer l’intégrité du cluster. Si elle n’est pas présente, l’évaluation d’intégrité utilise la stratégie d’intégrité du cluster définie dans le manifeste du cluster ou la stratégie d’intégrité du cluster par défaut. Par défaut, chaque application est évaluée à l’aide de sa stratégie d’intégrité d’application spécifique, définie dans le manifeste de l’application, ou de la stratégie d’intégrité par défaut, si aucune stratégie n’est définie dans le manifeste. Si le mappage de stratégie d’intégrité de l’application est spécifié et qu’il a une entrée pour une application, la stratégie d’intégrité de l’application spécifiée est utilisée pour évaluer l’intégrité de l’application.

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Une opération réussie retourne 200 status code et les informations d’intégrité du cluster demandées.	ClusterHealth
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via