État d’intégrité du service de rapport

Article
08/05/2023

Envoie un rapport d’intégrité sur le service Service Fabric.

Signale l’état d’intégrité du service Service Fabric spécifié. Le rapport doit contenir les informations sur la source du rapport d’intégrité et sur la propriété dont il fait état. Il est envoyé à un service de passerelle Service Fabric, qui opère son transfert vers le magasin d’intégrité. Le rapport peut être accepté par la passerelle, mais rejeté par le magasin d’intégrité après une validation supplémentaire. Par exemple, le magasin d’intégrité peut rejeter le rapport en raison d’un paramètre non valide, comme un numéro de séquence obsolète. Pour voir si le rapport a été appliqué dans le magasin d’intégrité, exécutez GetServiceHealth et case activée que le rapport s’affiche dans la section HealthEvents.

Requête

Méthode	URI de demande
POST	`/Services/{serviceId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`serviceId`	string	Oui	Chemin d’accès
`api-version`	string	Oui	Requête
`Immediate`	boolean	Non	Requête
`timeout`	integer (int64)	Non	Requête
`HealthInformation`	HealthInformation	Oui	body

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

`Immediate`

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

Indicateur qui spécifie si le rapport doit être envoyé immédiatement. Un rapport d’intégrité est envoyé à une application de passerelle Service Fabric, qui opère son transfert vers le magasin d’intégrité. Si le paramètre immediate est défini sur true, le rapport est immédiatement envoyé de la passerelle HTTP au magasin d’intégrité, quels que soient les paramètres du client Fabric qu’utilise l’application de passerelle HTTP. Cela est utile pour les rapports critiques qui doivent être envoyés dès que possible. En fonction du minutage et d’autres conditions, l’envoi du rapport peut quand même échouer, par exemple si la passerelle HTTP est fermée ou si le message n’atteint pas la passerelle. Si le paramètre immediate est défini sur false, le rapport est envoyé en fonction des paramètres du client d’intégrité de la passerelle HTTP. C’est pourquoi il est traité par lot selon la configuration HealthReportSendInterval. Il s’agit du paramètre recommandé, car il permet au client d’intégrité d’optimiser les messages de rapport d’intégrité envoyés au magasin d’intégrité, ainsi que le traitement des rapports d’intégrité. Par défaut, les rapports ne sont pas envoyés immédiatement.

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

`HealthInformation`

Type : HealthInformation
Obligatoire : Oui

Décrit les informations d’intégrité du rapport d’intégrité. Ces informations doivent être présentes dans tous les rapports d’intégrité envoyés au responsable de l’intégrité.

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Une opération réussie retourne 200 status code.
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via