Aller au contenu principal
NEXCLARADocumentation

Schémas : health

Schémas dont la première opération qui les emploie appartient à la famille health. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

DependencyState

Etat d'une dependance de fondation.

Type : object

PropriétéTypeRequisDescriptionContraintes
error_codestring | nullnonCode d'erreur stable si la sonde a echoue.
latency_msnumberouiDuree de la sonde en millisecondes.
namestringouiNom technique de la dependance.
status"up" | "down"ouiDisponibilite observee.

Employé par : healthReady

Environment

Environnements d'execution reconnus (Revision 1, section 8.1).

Type : string

Valeurs admises : local, shared_dev, staging, production

Employé par : serviceVersion

LivenessResponse

Reponse de la sonde de vivacite.

Type : object

PropriétéTypeRequisDescriptionContraintes
environmentstringouiEnvironnement declare par la configuration.
revisionstring | nullouiRevision Git de l'artefact deploye ; null hors deploiement.
servicestringouiNom technique du service.
status"alive"ouiLe processus API repond.
versionstringouiVersion du paquet API.

Employé par : healthLive

ReadinessResponse

Reponse de la sonde d'aptitude au trafic.

Type : object

PropriétéTypeRequisDescriptionContraintes
dependenciesarray<DependencyState>ouiEtat de chaque dependance de fondation reellement interrogee.
revisionstring | nullouiRevision Git de l'artefact deploye ; null hors deploiement.
servicestringouiNom technique du service.
status"ready" | "not_ready"ouiAptitude globale du service.
versionstringouiVersion du paquet API.

Employé par : healthReady

VersionResponse

Version servie : produit, revision, environnement, contrat, moteur.

Type : object

PropriétéTypeRequisDescriptionContraintes
api_versionstringouiVersion majeure du contrat d'API, celle du chemin.
engine_versionstring | nullouiVersion du moteur de decision enregistree avec chaque evaluation ; null pour CONTROL, qui n'execute pas le moteur.
environmentEnvironmentouiEnvironnement declare par la configuration.
revisionstring | nullouiSHA Git abrege (12 caracteres) de l'artefact deploye ; null hors deploiement.
versionstringouiVersion produit (SemVer), source unique : fichier racine VERSION.

Employé par : serviceVersion