Miglioramenti Healthcheck

Metadati di arricchimento per gli schemi relativi all’healthcheck. Vedere Estensioni OpenAPI per le definizioni delle estensioni.

Schemi arricchiti

Pattern

Tutti gli schemi corrispondenti a healthcheck.*SpecType ricevono arricchimenti:

• healthcheckCreateSpecType
• healthcheckReplaceSpecType
• healthcheckGetSpecType

Inoltre, lo schema annidato healthcheckHttpHealthCheck contiene arricchimenti per la configurazione del controllo di integrità HTTP.

Valori predefiniti applicati dal server

I campi contrassegnati con x-f5xc-server-default: true hanno il valore default applicato dal server API F5 XC quando omessi dalle richieste.

Campi di primo livello

Campo	Valore predefinito	Tipo	Descrizione
jitter	0	integer	Valore jitter assoluto per la casualizzazione dei tempi
jitter_percent	0	integer	Jitter basato su percentuale per la casualizzazione dei tempi

Schema healthcheckHttpHealthCheck

Campo	Valore predefinito	Tipo	Descrizione
use_origin_server_name	{}	object	Nome del Server di origine per l’intestazione Host
headers	{}	object	Intestazioni personalizzate
request_headers_to_remove	[]	array	Intestazioni da rimuovere dalle richieste
use_http2	false	boolean	Supporto HTTP/2
expected_status_codes	[]	array	Codici di stato accettati (vuoto = 200-299)

Valori consigliati

I campi contrassegnati con x-f5xc-recommended-value indicano valori che la console web F5 XC precompila durante la creazione di nuove risorse.

Campi di primo livello

Campo	Valore consigliato	Tipo	Descrizione
timeout	3	integer	Timeout del controllo di integrità in secondi
interval	15	integer	Intervallo tra i controlli di integrità in secondi
unhealthy_threshold	1	integer	Errori consecutivi prima di contrassegnare come non integro
healthy_threshold	3	integer	Successi consecutivi prima di contrassegnare come integro
jitter_percent	30	integer	Percentuale jitter per l’uso in produzione

Schema healthcheckHttpHealthCheck

Campo	Valore consigliato	Tipo	Descrizione
path	"/"	string	Percorso dell’endpoint di controllo di integrità
use_http2	false	boolean	Impostazione del supporto HTTP/2
expected_status_codes	["200"]	array	Codici di stato che indicano un’origine integra
use_origin_server_name	{}	object	Nome del Server di origine per l’intestazione Host

Raccomandazioni per le varianti OneOf

Gli schemi contenenti gruppi di campi mutuamente esclusivi (OneOf) includono x-f5xc-recommended-oneof-variant per indicare quale variante è più comunemente utilizzata. Questi metadati identificano la scelta tipica quando esistono più opzioni, in base ai valori predefiniti della console F5 XC e ai modelli di utilizzo comuni.

Gruppi OneOf di primo livello

Schema	Gruppo OneOf	Variante consigliata	Descrizione
healthcheckCreateSpecType	health_check	http_health_check	Tipo di controllo di integrità HTTP
healthcheckReplaceSpecType	health_check	http_health_check	Tipo di controllo di integrità HTTP

Gruppi OneOf di healthcheckHttpHealthCheck

Schema	Gruppo OneOf	Variante consigliata	Descrizione
healthcheckHttpHealthCheck	host_header_choice	use_origin_server_name	Intestazione Host per le richieste di controllo di integrità

Scelta dell’intestazione Host

Il gruppo OneOf host_header_choice controlla come viene specificata l’intestazione Host nelle richieste HTTP di controllo di integrità.

Variante	Tipo	Descrizione
use_origin_server_name	object (vuoto)	Utilizza il nome del server di origine come intestazione Host. Questa è la selezione predefinita nella console F5 XC.
host_header	string	Specifica un valore personalizzato per l’intestazione Host nelle richieste di controllo di integrità.

Riferimento allo schema API: x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

Riferimento alle estensioni OpenAPI

Queste estensioni del fornitore vengono aggiunte allo schema OpenAPI standard per comunicare il comportamento predefinito specifico di F5 XC.

x-f5xc-server-default

Tipo: boolean

Quando è true, indica che il valore default associato viene applicato dal server API F5 XC. I campi con questa estensione possono essere omessi in modo sicuro dalle richieste API: il server applica automaticamente il valore predefinito.

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

x-f5xc-recommended-value

Tipo: any (corrisponde al tipo di campo)

Specifica un valore che la console web F5 XC utilizza come valore predefinito precompilato. Questo valore non è applicato dal server, ma rappresenta la configurazione di partenza tipica per le nuove risorse create tramite la console.

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

x-f5xc-recommended-oneof-variant

Tipo: object (mappa del nome del gruppo al nome della variante)

Per gli schemi con gruppi di campi mutuamente esclusivi, identifica quale variante è la scelta predefinita o più comune. La chiave è il nome del gruppo OneOf e il valore è il nome del campo della variante consigliata.

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

Accesso ai dati

Specifiche API

File	Contenuto
docs/specifications/api/virtual.json	healthcheckHttpHealthCheck, healthcheckCreateSpecType, healthcheckReplaceSpecType, healthcheckGetSpecType
docs/specifications/api/openapi.json	Specifica unificata con tutti gli schemi

Struttura di validation.json

defaults.resources.healthcheck
├── server_applied      # Fields with x-f5xc-server-default: true
├── recommended         # Fields with x-f5xc-recommended-value
├── oneof_recommended   # OneOf variant recommendations
└── nested_recommended  # Nested schema recommended values

Documentazione correlata

• Guida allo sviluppo - Estensioni OpenAPI - Definizioni e utilizzo delle estensioni
• Specifica di validazione - Formato e struttura di validation.json
• Miglioramenti Origin Pool - Arricchimenti dello schema del pool di origine

Changelog

Versione	Data	Modifiche
2.1.4	2026-01-19	Aggiunta documentazione del gruppo OneOf host_header_choice per i parametri delle richieste di controllo di integrità HTTP
2.1.3	2026-01-18	Consolidata la documentazione globale delle estensioni in DEVELOPMENT.md; solo dati specifici per risorsa
2.1.2	2026-01-18	Riscritto come riferimento API puro; rimossi esempi downstream e linguaggio prescrittivo
2.1.1	2026-01-18	Aggiunti valori consigliati annidati, varianti OneOf consigliate, estensione x-f5xc-recommended-oneof-variant
2.1.0	2026-01-18	Aggiunta struttura di valori predefiniti unificata in validation.json
2.0.30	2026-01-16	Aggiunti valori predefiniti annidati per gli schemi $ref
2.0.29	2026-01-17	Valori predefiniti iniziali per healthcheck