Partager via

Obtenir l’intégrité du service

  • Article

Permet d’obtenir l’intégrité du service Service Fabric spécifié.

Permet d’obtenir les informations d’intégrité du service spécifié. EventsHealthStateFilter permet de filtrer la collection d’événements d’intégrité signalés dans le service en fonction de l’état d’intégrité. Utilisez PartitionsHealthStateFilter pour filtrer la collection de partitions retournée. Si vous spécifiez un service qui n’existe pas dans le magasin d’intégrité, cette requête retourne une erreur.

Requête

Méthode URI de demande
GET /Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
serviceId string Oui Chemin d’accès
api-version string Oui Requête
EventsHealthStateFilter entier Non Requête
PartitionsHealthStateFilter entier Non Requête
ExcludeHealthStatistics boolean Non Requête
timeout entier (int64) Non Requête

serviceId

Type : chaîne
Obligatoire : Oui

Identité du service. Cet ID est généralement le nom complet du service 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 un service est nommé « fabric:/myapp/app1/svc1 », son identité de service est « myapp~app1~svc1 » dans les versions 6.0 et ultérieures et « myapp/app1/svc1 » dans les versions antérieures.

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 d’API inférieure est transmise, 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 si 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 en fonction de 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.
  • 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.

PartitionsHealthStateFilter

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

Permet de filtrer les objets d’état d’intégrité des partitions retournés dans le résultat de la requête d’intégrité du service 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. Seules les partitions qui correspondent au filtre sont retournées. Toutes les partitions 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 partitions 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.
  • 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.

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é du service spécifié.
 ServiceHealth
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError