Obtenez la santé des applications en utilisant la politique

Obtient la santé d’une application De tissu de service utilisant la stratégie spécifiée.

Obtient la santé d’une application De tissu de service. EventsHealthStateFilter permet de filtrer la collection d’événements d’intégrité signalés dans le nœud en fonction de l’état d’intégrité. Utilisez ClusterHealthPolicies pour remplacer les politiques de santé utilisées pour évaluer la santé.

Requête

Méthode URI de demande
POST /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
applicationId string Oui Path
api-version string Oui Requête
EventsHealthStateFilter entier Non Requête
DeployedApplicationsHealthStateFilter entier Non Requête
ServicesHealthStateFilter entier Non Requête
ExcludeHealthStatistics boolean Non Requête
timeout integer (int64) Non Requête
ApplicationHealthPolicy ApplicationHealthPolicy (en) Non body

applicationId

Type: chaîne
Requis: Oui

Identité de l’application. Il s’agit généralement du nom complet de l’application, sans le schéma d’URI « fabric: ». 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
Requis: Oui
Défaut:6.0

Version de l’API. Ce paramètre est nécessaire et sa valeur doit être de 6,0.

Service Fabric REST version API est basé sur la version de durée d’exécution dans laquelle l’API a été introduit ou a été changé. Service Fabric runtime prend en charge plus d’une version de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version API inférieure est adoptée, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le temps d’exécution accepter toute version qui est supérieure à la dernière version prise en charge jusqu’à la version actuelle de l’exécution. Donc, si la dernière version API est 6.0, mais si le temps d’exécution est de 6.1, afin de le rendre plus facile d’écrire les clients, le temps d’exécution acceptera la version 6.1 pour cette API. Cependant, le comportement de l’API sera selon la version 6.0 documentée.


EventsHealthStateFilter

Type: intégrer
Requis: Non
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.

  • 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 HealthState avertissement de valeur. La valeur est égale à 4.
  • Erreur - Filtre qui correspond à l’entrée avec l’erreur de valeur HealthState. La valeur est égale à 8.
  • Tous - Filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

DeployedApplicationsHealthStateFilter

Type: intégrer
Requis: Non
Défaut:0

Permet de filtrer, par état d’intégrité, les objets d’état d’intégrité des applications déployées qui sont retournés dans le résultat de la requête d’intégrité de l’application. Les valeurs possibles de ce paramètre incluent la valeur entière de l’un des états d’intégrité suivants. Seules les applications déployées qui correspondent au filtre sont retournées. Toutes les applications déployées 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 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 applications déployées dont la valeur HealthState est OK (2) et Warning (4) est retourné.

  • 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 HealthState avertissement de valeur. La valeur est égale à 4.
  • Erreur - Filtre qui correspond à l’entrée avec l’erreur de valeur HealthState. La valeur est égale à 8.
  • Tous - Filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

ServicesHealthStateFilter

Type: intégrer
Requis: Non
Défaut:0

Permet de filtrer, par état d’intégrité, les objets d’état d’intégrité des services qui sont retournés dans le résultat de la requête d’intégrité des services. Les valeurs possibles de ce paramètre incluent la valeur entière de l’un des états d’intégrité suivants. Seuls les services qui correspondent au filtre sont retournés. Tous les services 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, l’état d’intégrité des services dont la valeur HealthState est OK (2) et Warning (4) est retourné.

  • 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 HealthState avertissement de valeur. La valeur est égale à 4.
  • Erreur - Filtre qui correspond à l’entrée avec l’erreur de valeur HealthState. La valeur est égale à 8.
  • Tous - Filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

ExcludeHealthStatistics

Type: boolean
Requis: Non
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: intégré (int64)
Requis: Non
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.


ApplicationHealthPolicy

Type: ApplicationHealthPolicy
Requis: Non

Décrit les politiques de santé utilisées pour évaluer la santé d’une application ou d’un de ses enfants. Si elle n’est pas présente, l’évaluation de la santé utilise la politique de santé à partir du manifeste de l’application ou de la politique de santé par défaut.

Réponses

Code d’état HTTP Description Schéma de réponse
200 (OK) Une opération réussie retournera 200 code d’état et les renseignements sur la santé des nœuds demandés.
ApplicationHealth (en)
Tous les autres codes de statut La réponse détaillée d’erreur.
FabricError (en)