Healthcheck-Erweiterungen

Anreicherungsmetadaten für Healthcheck-bezogene Schemata. Siehe OpenAPI-Erweiterungen für Erweiterungsdefinitionen.

Angereicherte Schemata

Muster

Alle Schemata, die healthcheck.*SpecType entsprechen, erhalten Anreicherungen:

• healthcheckCreateSpecType
• healthcheckReplaceSpecType
• healthcheckGetSpecType

Zusätzlich enthält das verschachtelte Schema healthcheckHttpHealthCheck Anreicherungen für die HTTP-Healthcheck-Konfiguration.

Serverseitig angewendete Standardwerte

Felder, die mit x-f5xc-server-default: true gekennzeichnet sind, erhalten ihren default-Wert vom F5 XC API-Server angewendet, wenn sie in Anfragen ausgelassen werden.

Felder der obersten Ebene

Feld	Standardwert	Typ	Beschreibung
jitter	0	integer	Absoluter Jitter-Wert für die Zeitsteuerungs-Randomisierung
jitter_percent	0	integer	Prozentbasierter Jitter für die Zeitsteuerungs-Randomisierung

healthcheckHttpHealthCheck-Schema

Feld	Standardwert	Typ	Beschreibung
use_origin_server_name	{}	object	Ursprungsservername für den Host-Header
headers	{}	object	Benutzerdefinierte Header
request_headers_to_remove	[]	array	Header, die aus Anfragen entfernt werden sollen
use_http2	false	boolean	HTTP/2-Unterstützung
expected_status_codes	[]	array	Akzeptierte Statuscodes (leer = 200–299)

Empfohlene Werte

Felder, die mit x-f5xc-recommended-value gekennzeichnet sind, geben Werte an, die die F5 XC Webkonsole beim Erstellen neuer Ressourcen vorausfüllt.

Felder der obersten Ebene

Feld	Empfohlener Wert	Typ	Beschreibung
timeout	3	integer	Healthcheck-Timeout in Sekunden
interval	15	integer	Intervall zwischen Healthchecks in Sekunden
unhealthy_threshold	1	integer	Aufeinanderfolgende Fehler, bevor als fehlerhaft markiert wird
healthy_threshold	3	integer	Aufeinanderfolgende Erfolge, bevor als fehlerfrei markiert wird
jitter_percent	30	integer	Jitter-Prozentsatz für den Produktionseinsatz

healthcheckHttpHealthCheck-Schema

Feld	Empfohlener Wert	Typ	Beschreibung
path	"/"	string	Healthcheck-Endpunkt-Pfad
use_http2	false	boolean	HTTP/2-Unterstützungseinstellung
expected_status_codes	["200"]	array	Statuscodes, die einen fehlerfreien Ursprung anzeigen
use_origin_server_name	{}	object	Ursprungsservername für den Host-Header

OneOf-Variantenempfehlungen

Schemata, die gegenseitig ausschließende Feldgruppen (OneOf) enthalten, schließen x-f5xc-recommended-oneof-variant ein, um anzugeben, welche Variante am häufigsten verwendet wird. Diese Metadaten identifizieren die typische Auswahl bei mehreren Optionen, basierend auf den Standardeinstellungen der F5 XC Konsole und gängigen Verwendungsmustern.

OneOf-Gruppen der obersten Ebene

Schema	OneOf-Gruppe	Empfohlene Variante	Beschreibung
healthcheckCreateSpecType	health_check	http_health_check	HTTP-Healthcheck-Typ
healthcheckReplaceSpecType	health_check	http_health_check	HTTP-Healthcheck-Typ

healthcheckHttpHealthCheck-OneOf-Gruppen

Schema	OneOf-Gruppe	Empfohlene Variante	Beschreibung
healthcheckHttpHealthCheck	host_header_choice	use_origin_server_name	Host-Header für Healthcheck-Anfragen

Host-Header-Auswahl

Die OneOf-Gruppe host_header_choice steuert, wie der Host-Header in HTTP-Anfragen für Healthchecks angegeben wird.

Variante	Typ	Beschreibung
use_origin_server_name	object (leer)	Den Ursprungsservernamen als Host-Header verwenden. Dies ist die Standardauswahl in der F5 XC Konsole.
host_header	string	Einen benutzerdefinierten Host-Header-Wert für Healthcheck-Anfragen angeben.

API-Schemareferenz: x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

Referenz der OpenAPI-Erweiterungen

Diese Herstellererweiterungen werden dem standardmäßigen OpenAPI-Schema hinzugefügt, um das F5 XC-spezifische Standardverhalten zu vermitteln.

x-f5xc-server-default

Typ: boolean

Wenn true, gibt dies an, dass der begleitende default-Wert vom F5 XC API-Server erzwungen wird. Felder mit dieser Erweiterung können sicher aus API-Anfragen ausgelassen werden – der Server wendet den Standardwert automatisch an.

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

x-f5xc-recommended-value

Typ: any (entspricht dem Feldtyp)

Gibt einen Wert an, den die F5 XC Webkonsole als vorausgefüllten Standardwert verwendet. Dieser Wert wird nicht serverseitig erzwungen, sondern stellt die typische Ausgangskonfiguration für neue über die Konsole erstellte Ressourcen dar.

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

x-f5xc-recommended-oneof-variant

Typ: object (Zuordnung von Gruppenname zu Variantenname)

Für Schemata mit gegenseitig ausschließenden Feldgruppen wird angegeben, welche Variante die Standard- oder häufigste Auswahl ist. Der Schlüssel ist der Name der OneOf-Gruppe und der Wert ist der empfohlene Variantenfeldname.

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

Datenzugriff

OpenAPI-Spezifikationen

Datei	Inhalt
docs/specifications/api/virtual.json	healthcheckHttpHealthCheck, healthcheckCreateSpecType, healthcheckReplaceSpecType, healthcheckGetSpecType
docs/specifications/api/openapi.json	Zusammengeführte Spezifikation mit allen Schemata

validation.json-Struktur

defaults.resources.healthcheck
├── server_applied      # Felder mit x-f5xc-server-default: true
├── recommended         # Felder mit x-f5xc-recommended-value
├── oneof_recommended   # OneOf-Variantenempfehlungen
└── nested_recommended  # Empfohlene Werte für verschachtelte Schemata

Verwandte Dokumentation

• Entwicklungsleitfaden – OpenAPI-Erweiterungen – Erweiterungsdefinitionen und Verwendung
• Validierungsspezifikation – validation.json-Format und -Struktur
• Ursprungspool-Erweiterungen – Schemaanreicherungen für Ursprungspools

Änderungsprotokoll

Version	Datum	Änderungen
2.1.4	2026-01-19	Dokumentation der OneOf-Gruppe host_header_choice für HTTP-Healthcheck-Anfrageparameter hinzugefügt
2.1.3	2026-01-18	Globale Erweiterungsdokumente in DEVELOPMENT.md konsolidiert; nur ressourcenspezifische Daten
2.1.2	2026-01-18	Als reine API-Referenz neu geschrieben; nachgelagerte Beispiele und präskriptive Sprache entfernt
2.1.1	2026-01-18	Verschachtelte empfohlene Werte, OneOf-Variantenempfehlungen und Erweiterung x-f5xc-recommended-oneof-variant hinzugefügt
2.1.0	2026-01-18	Einheitliche Standardwertstruktur in validation.json hinzugefügt
2.0.30	2026-01-16	Verschachtelte Standardwerte für $ref-Schemata hinzugefügt
2.0.29	2026-01-17	Erste Healthcheck-Standardwerte