Obtenir l’intégrité des applications déployées

Article
07/19/2023

Permet d’obtenir les informations relatives à l’intégrité d’une application déployée sur un nœud Service Fabric.

Permet d’obtenir les informations relatives à l’intégrité d’une application déployée sur un nœud Service Fabric. Utilisez EventsHealthStateFilter pour filtrer éventuellement la collection d’objets HealthEvent signalés sur l’application déployée en fonction d’un état d’intégrité. Utilisez DeployedServicePackagesHealthStateFilter pour filtrer éventuellement les enfants de DeployedServicePackageHealth en fonction d’un état d’intégrité.

Requête

Méthode	URI de demande
GET	`/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`nodeName`	string	Oui	Chemin d’accès
`applicationId`	string	Oui	Chemin d’accès
`api-version`	string	Oui	Requête
`EventsHealthStateFilter`	entier	Non	Requête
`DeployedServicePackagesHealthStateFilter`	entier	Non	Requête
`ExcludeHealthStatistics`	boolean	Non	Requête
`timeout`	integer (int64)	Non	Requête

`nodeName`

Type : chaîne
Obligatoire : Oui

Nom du nœud.

`applicationId`

Type : chaîne
Obligatoire : Oui

Identité de l’application. Il s’agit généralement du nom complet de l’application, sans « fabric ». Schéma d’URI. Depuis la version 6.0, les noms hiérarchiques sont séparés par le caractère « ~ ». Par exemple, si une application est nommée « fabric://mon_app/app1 », son identité est « mon_app~app1 » dans les versions 6.0 et supérieures, et « mon_app/app1 » dans les versions précédentes.

`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.

`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.
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.

`DeployedServicePackagesHealthStateFilter`

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

Permet de filtrer, par état d’intégrité, les objets d’état d’intégrité des packages de services déployés qui sont retournés dans le résultat de la requête d’intégrité de l’application déployée. Les valeurs possibles de ce paramètre incluent la valeur entière de l’un des états d’intégrité suivants. Seuls les packages de services déployés qui correspondent au filtre sont retournés. Tous les packages de services déployés sont utilisés pour évaluer l’état d’intégrité agrégé de l’application déployée. 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, l’état d’intégrité des packages de services 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 à 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.

`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.

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é de l’application déployée.	DeployedApplicationHealth
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via