健康檢查增強功能

健康檢查相關結構描述的擴充元資料。擴充定義請參閱 OpenAPI 擴充。

已擴充的結構描述

模式

所有符合 healthcheck.*SpecType 的結構描述均會收到擴充：

healthcheckCreateSpecType
healthcheckReplaceSpecType
healthcheckGetSpecType

此外，巢狀結構描述 healthcheckHttpHealthCheck 包含 HTTP 健康檢查設定的擴充。

伺服器套用的預設值

標記有 x-f5xc-server-default: true 的欄位，其 default 值會在請求中省略時由 F5 XC API 伺服器自動套用。

頂層欄位

欄位	預設值	類型	說明
`jitter`	`0`	integer	計時隨機化的絕對抖動值
`jitter_percent`	`0`	integer	計時隨機化的百分比型抖動

healthcheckHttpHealthCheck 結構描述

欄位	預設值	類型	說明
`use_origin_server_name`	`{}`	object	Host 標頭的來源伺服器名稱
`headers`	`{}`	object	自訂標頭
`request_headers_to_remove`	`[]`	array	需從請求中移除的標頭
`use_http2`	`false`	boolean	HTTP/2 支援
`expected_status_codes`	`[]`	array	接受的狀態碼（空值 = 200-299）

建議值

標記有 x-f5xc-recommended-value 的欄位，表示 F5 XC 網頁主控台在建立新資源時預先填入的值。

頂層欄位

欄位	建議值	類型	說明
`timeout`	`3`	integer	健康檢查逾時秒數
`interval`	`15`	integer	健康檢查間隔秒數
`unhealthy_threshold`	`1`	integer	標記為不健康前的連續失敗次數
`healthy_threshold`	`3`	integer	標記為健康前的連續成功次數
`jitter_percent`	`30`	integer	生產環境使用的抖動百分比

healthcheckHttpHealthCheck 結構描述

欄位	建議值	類型	說明
`path`	`"/"`	string	健康檢查端點路徑
`use_http2`	`false`	boolean	HTTP/2 支援設定
`expected_status_codes`	`["200"]`	array	表示來源健康的狀態碼
`use_origin_server_name`	`{}`	object	Host 標頭的來源伺服器名稱

OneOf 變體建議

包含互斥欄位群組（OneOf）的結構描述會附帶 x-f5xc-recommended-oneof-variant，用以指出最常使用的變體。此元資料根據 F5 XC 主控台預設值及常見使用模式，識別在多個選項存在時的典型選擇。

頂層 OneOf 群組

結構描述	OneOf 群組	建議變體	說明
`healthcheckCreateSpecType`	`health_check`	`http_health_check`	HTTP 健康檢查類型
`healthcheckReplaceSpecType`	`health_check`	`http_health_check`	HTTP 健康檢查類型

healthcheckHttpHealthCheck OneOf 群組

結構描述	OneOf 群組	建議變體	說明
`healthcheckHttpHealthCheck`	`host_header_choice`	`use_origin_server_name`	健康檢查請求的 Host 標頭

Host 標頭選擇

host_header_choice OneOf 群組控制健康檢查 HTTP 請求中 Host 標頭的指定方式。

變體	類型	說明
`use_origin_server_name`	`object`（空值）	使用來源伺服器名稱作為 Host 標頭。此為 F5 XC 主控台的預設選擇。
`host_header`	`string`	為健康檢查請求指定自訂 Host 標頭值。

API 結構描述參考：x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

OpenAPI 擴充參考

這些供應商擴充會加入標準 OpenAPI 結構描述，以傳達 F5 XC 特定的預設行為。

x-f5xc-server-default

類型：boolean

當值為 true 時，表示伴隨的 default 值由 F5 XC API 伺服器強制執行。具有此擴充的欄位可安全地從 API 請求中省略——伺服器會自動套用預設值。

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

x-f5xc-recommended-value

類型：any（符合欄位類型）

指定 F5 XC 網頁主控台用作預先填入預設值的值。此值不由伺服器強制執行，但代表透過主控台建立新資源時的典型初始設定。

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

x-f5xc-recommended-oneof-variant

類型：object（群組名稱至變體名稱的對應）

對於包含互斥欄位群組的結構描述，識別哪個變體是預設或最常見的選擇。鍵為 OneOf 群組名稱，值為建議的變體欄位名稱。

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

資料存取

OpenAPI 規格

檔案	內容
`docs/specifications/api/virtual.json`	`healthcheckHttpHealthCheck`、`healthcheckCreateSpecType`、`healthcheckReplaceSpecType`、`healthcheckGetSpecType`
`docs/specifications/api/openapi.json`	包含所有結構描述的合併規格

validation.json 結構

defaults.resources.healthcheck
├── server_applied      # 具有 x-f5xc-server-default: true 的欄位
├── recommended         # 具有 x-f5xc-recommended-value 的欄位
├── oneof_recommended   # OneOf 變體建議
└── nested_recommended  # 巢狀結構描述建議值

更新日誌

版本	日期	變更內容
2.1.4	2026-01-19	新增 HTTP 健康檢查請求參數的 `host_header_choice` OneOf 群組文件
2.1.3	2026-01-18	將全域擴充文件整合至 DEVELOPMENT.md；僅保留資源特定資料
2.1.2	2026-01-18	改寫為純 API 參考；移除下游範例及規範性語言
2.1.1	2026-01-18	新增巢狀建議值、OneOf 建議變體、`x-f5xc-recommended-oneof-variant` 擴充
2.1.0	2026-01-18	在 validation.json 中新增統一預設值結構
2.0.30	2026-01-16	為 `$ref` 結構描述新增巢狀預設值
2.0.29	2026-01-17	初始健康檢查預設值

健康檢查增強功能

已擴充的結構描述

模式

伺服器套用的預設值

頂層欄位

healthcheckHttpHealthCheck 結構描述

建議值

頂層欄位

healthcheckHttpHealthCheck 結構描述

OneOf 變體建議

頂層 OneOf 群組

healthcheckHttpHealthCheck OneOf 群組

Host 標頭選擇

OpenAPI 擴充參考

x-f5xc-server-default

x-f5xc-recommended-value

x-f5xc-recommended-oneof-variant

資料存取

OpenAPI 規格

validation.json 結構

相關文件

更新日誌