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

Obtient l’intégrité d’un réplica de service avec état Service Fabric ou d’une instance de service sans état à l’aide de la stratégie spécifiée.

Permet d’obtenir l’intégrité d’une instance de service sans état ou d’un réplica de service avec état Service Fabric. 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é. Utilisez ApplicationHealthPolicy pour remplacer éventuellement les stratégies d’intégrité utilisées pour évaluer l’intégrité. Cette API utilise uniquement le champ « ConsiderWarningAsError » de l’ApplicationHealthPolicy. Les autres champs sont ignorés lors de l’évaluation de l’intégrité du réplica.

Requête

Méthode URI de demande
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
partitionId string (uuid) Oui Path
replicaId string Oui Path
api-version string Oui Requête
EventsHealthStateFilter entier Non Requête
timeout entier (int64) Non Requête
ApplicationHealthPolicy ApplicationHealthPolicy Non body

partitionId

Type : chaîne (uuid)
Obligatoire : Oui

Identité de la partition.


replicaId

Type : chaîne
Obligatoire : Oui

Identificateur du réplica.


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

Service Fabric version de l’API REST est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Service Fabric runtime 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 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. Ainsi, 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 de cette API. Toutefois, le comportement de l’API sera identique à la version documentée de 6.0.


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.
  • Tout - Filtre qui correspond à l’entrée avec n’importe quelle valeur HealthState. La valeur est égale à 65535.

timeout

Type : entier (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.


ApplicationHealthPolicy

Type : ApplicationHealthPolicy
Obligatoire : Non

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

Réponses

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