Améliorations du bilan de santé

Métadonnées d’enrichissement pour les schémas liés au bilan de santé. Voir Extensions OpenAPI pour les définitions des extensions.

Schémas enrichis

Modèle

Tous les schémas correspondant à healthcheck.*SpecType reçoivent des enrichissements :

healthcheckCreateSpecType
healthcheckReplaceSpecType
healthcheckGetSpecType

De plus, le schéma imbriqué healthcheckHttpHealthCheck contient des enrichissements pour la configuration du bilan de santé HTTP.

Valeurs par défaut appliquées par le serveur

Les champs marqués avec x-f5xc-server-default: true ont leur valeur default appliquée par le serveur API F5 XC lorsqu’ils sont omis des requêtes.

Champs de niveau supérieur

Champ	Valeur par défaut	Type	Description
`jitter`	`0`	entier	Valeur de gigue absolue pour la randomisation temporelle
`jitter_percent`	`0`	entier	Gigue en pourcentage pour la randomisation temporelle

Schéma healthcheckHttpHealthCheck

Champ	Valeur par défaut	Type	Description
`use_origin_server_name`	`{}`	objet	Nom du serveur d’origine pour l’en-tête Host
`headers`	`{}`	objet	En-têtes personnalisés
`request_headers_to_remove`	`[]`	tableau	En-têtes à supprimer des requêtes
`use_http2`	`false`	booléen	Support HTTP/2
`expected_status_codes`	`[]`	tableau	Codes de statut acceptés (vide = 200-299)

Valeurs recommandées

Les champs marqués avec x-f5xc-recommended-value indiquent des valeurs que la console web F5 XC pré-remplit lors de la création de nouvelles ressources.

Champs de niveau supérieur

Champ	Valeur recommandée	Type	Description
`timeout`	`3`	entier	Délai d’expiration du bilan de santé en secondes
`interval`	`15`	entier	Intervalle entre les bilans de santé en secondes
`unhealthy_threshold`	`1`	entier	Nombre d’échecs consécutifs avant de marquer comme non sain
`healthy_threshold`	`3`	entier	Nombre de succès consécutifs avant de marquer comme sain
`jitter_percent`	`30`	entier	Pourcentage de gigue pour une utilisation en production

Schéma healthcheckHttpHealthCheck

Champ	Valeur recommandée	Type	Description
`path`	`"/"`	chaîne	Chemin du point de terminaison du bilan de santé
`use_http2`	`false`	booléen	Paramètre de support HTTP/2
`expected_status_codes`	`["200"]`	tableau	Codes de statut indiquant une origine saine
`use_origin_server_name`	`{}`	objet	Nom du serveur d’origine pour l’en-tête Host

Recommandations de variantes OneOf

Les schémas contenant des groupes de champs mutuellement exclusifs (OneOf) incluent x-f5xc-recommended-oneof-variant pour indiquer quelle variante est la plus couramment utilisée. Ces métadonnées identifient le choix typique lorsque plusieurs options existent, sur la base des valeurs par défaut de la console F5 XC et des modèles d’utilisation courants.

Groupes OneOf de niveau supérieur

Schéma	Groupe OneOf	Variante recommandée	Description
`healthcheckCreateSpecType`	`health_check`	`http_health_check`	Type de bilan de santé HTTP
`healthcheckReplaceSpecType`	`health_check`	`http_health_check`	Type de bilan de santé HTTP

Groupes OneOf de healthcheckHttpHealthCheck

Schéma	Groupe OneOf	Variante recommandée	Description
`healthcheckHttpHealthCheck`	`host_header_choice`	`use_origin_server_name`	En-tête Host pour les requêtes de bilan de santé

Choix de l’en-tête Host

Le groupe OneOf host_header_choice contrôle la façon dont l’en-tête Host est spécifié dans les requêtes HTTP de bilan de santé.

Variante	Type	Description
`use_origin_server_name`	`object` (vide)	Utiliser le nom du serveur d’origine comme en-tête Host. Il s’agit de la sélection par défaut dans la console F5 XC.
`host_header`	`string`	Spécifier une valeur d’en-tête Host personnalisée pour les requêtes de bilan de santé.

Référence du schéma API : x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

Référence des extensions OpenAPI

Ces extensions fournisseurs sont ajoutées au schéma OpenAPI standard pour transmettre le comportement par défaut spécifique à F5 XC.

x-f5xc-server-default

Type : boolean

Lorsque la valeur est true, indique que la valeur default associée est appliquée par le serveur API F5 XC. Les champs portant cette extension peuvent être omis en toute sécurité des requêtes API — le serveur applique la valeur par défaut automatiquement.

use_http2:
  type: boolean
  default: false
  x-f5xc-server-default: true

x-f5xc-recommended-value

Type : any (correspond au type du champ)

Spécifie une valeur que la console web F5 XC utilise comme valeur par défaut pré-remplie. Cette valeur n’est pas appliquée par le serveur, mais représente la configuration de départ typique pour les nouvelles ressources créées via la console.

timeout:
  type: integer
  x-f5xc-recommended-value: 3

x-f5xc-recommended-oneof-variant

Type : object (correspondance entre nom de groupe et nom de variante)

Pour les schémas avec des groupes de champs mutuellement exclusifs, identifie quelle variante est le choix par défaut ou le plus courant. La clé est le nom du groupe OneOf et la valeur est le nom du champ de la variante recommandée.

healthcheckCreateSpecType:
  type: object
  x-f5xc-recommended-oneof-variant:
    health_check: "http_health_check"

Accès aux données

Spécifications API

Fichier	Contenu
`docs/specifications/api/virtual.json`	`healthcheckHttpHealthCheck`, `healthcheckCreateSpecType`, `healthcheckReplaceSpecType`, `healthcheckGetSpecType`
`docs/specifications/api/openapi.json`	Spécification fusionnée avec tous les schémas

Structure de validation.json

defaults.resources.healthcheck
├── server_applied      # Champs avec x-f5xc-server-default: true
├── recommended         # Champs avec x-f5xc-recommended-value
├── oneof_recommended   # Recommandations de variantes OneOf
└── nested_recommended  # Valeurs recommandées pour les schémas imbriqués

Documentation connexe

Guide de développement - Extensions OpenAPI - Définitions et utilisation des extensions
Spécification de validation - Format et structure de validation.json
Améliorations du pool d’origine - Enrichissements du schéma de pool d’origine

Journal des modifications

Version	Date	Modifications
2.1.4	2026-01-19	Ajout de la documentation du groupe OneOf `host_header_choice` pour les paramètres de requête de bilan de santé HTTP
2.1.3	2026-01-18	Consolidation de la documentation globale des extensions dans DEVELOPMENT.md ; données spécifiques aux ressources uniquement
2.1.2	2026-01-18	Réécrit en tant que référence API pure ; suppression des exemples en aval et du langage prescriptif
2.1.1	2026-01-18	Ajout des valeurs recommandées imbriquées, des variantes OneOf recommandées, de l’extension `x-f5xc-recommended-oneof-variant`
2.1.0	2026-01-18	Ajout de la structure de valeurs par défaut unifiée dans validation.json
2.0.30	2026-01-16	Ajout des valeurs par défaut imbriquées pour les schémas `$ref`
2.0.29	2026-01-17	Valeurs par défaut initiales du bilan de santé