การปรับปรุง Healthcheck

ข้อมูลเมตาสำหรับการเพิ่มประสิทธิภาพ schema ที่เกี่ยวข้องกับ healthcheck ดู OpenAPI Extensions สำหรับคำจำกัดความของ extension

Schema ที่ได้รับการเพิ่มประสิทธิภาพ

รูปแบบ

Schema ทั้งหมดที่ตรงกับ healthcheck.*SpecType จะได้รับการเพิ่มประสิทธิภาพ:

healthcheckCreateSpecType
healthcheckReplaceSpecType
healthcheckGetSpecType

นอกจากนี้ schema ที่ซ้อนอยู่ healthcheckHttpHealthCheck ยังมีการเพิ่มประสิทธิภาพสำหรับการกำหนดค่า HTTP health check

ค่าเริ่มต้นที่เซิร์ฟเวอร์กำหนด

ฟิลด์ที่ทำเครื่องหมายด้วย x-f5xc-server-default: true จะมีค่า default ถูกกำหนดโดย F5 XC API server เมื่อไม่มีการระบุค่าในคำขอ

ฟิลด์ระดับบนสุด

ฟิลด์	ค่าเริ่มต้น	ประเภท	คำอธิบาย
`jitter`	`0`	integer	ค่า jitter แบบสัมบูรณ์สำหรับการสุ่มเวลา
`jitter_percent`	`0`	integer	ค่า jitter แบบเปอร์เซ็นต์สำหรับการสุ่มเวลา

Schema healthcheckHttpHealthCheck

ฟิลด์	ค่าเริ่มต้น	ประเภท	คำอธิบาย
`use_origin_server_name`	`{}`	object	ชื่อเซิร์ฟเวอร์ต้นทางสำหรับ Host header
`headers`	`{}`	object	Custom headers
`request_headers_to_remove`	`[]`	array	Headers ที่จะตัดออกจากคำขอ
`use_http2`	`false`	boolean	รองรับ HTTP/2
`expected_status_codes`	`[]`	array	รหัสสถานะที่ยอมรับ (ว่างเปล่า = 200-299)

ค่าที่แนะนำ

ฟิลด์ที่ทำเครื่องหมายด้วย x-f5xc-recommended-value ระบุค่าที่ F5 XC เว็บคอนโซลกรอกไว้ล่วงหน้าเมื่อสร้างทรัพยากรใหม่

ฟิลด์ระดับบนสุด

ฟิลด์	ค่าที่แนะนำ	ประเภท	คำอธิบาย
`timeout`	`3`	integer	เวลาหมดอายุของ health check เป็นวินาที
`interval`	`15`	integer	ช่วงเวลาระหว่าง health check เป็นวินาที
`unhealthy_threshold`	`1`	integer	จำนวนครั้งที่ล้มเหลวติดต่อกันก่อนทำเครื่องหมายว่าไม่ปกติ
`healthy_threshold`	`3`	integer	จำนวนครั้งที่สำเร็จติดต่อกันก่อนทำเครื่องหมายว่าปกติ
`jitter_percent`	`30`	integer	เปอร์เซ็นต์ jitter สำหรับการใช้งานในสภาพแวดล้อมจริง

Schema healthcheckHttpHealthCheck

ฟิลด์	ค่าที่แนะนำ	ประเภท	คำอธิบาย
`path`	`"/"`	string	เส้นทาง endpoint ของ health check
`use_http2`	`false`	boolean	การตั้งค่ารองรับ HTTP/2
`expected_status_codes`	`["200"]`	array	รหัสสถานะที่ระบุว่า origin มีสถานะปกติ
`use_origin_server_name`	`{}`	object	ชื่อเซิร์ฟเวอร์ต้นทางสำหรับ Host header

คำแนะนำสำหรับ OneOf Variant

Schema ที่มีกลุ่มฟิลด์แบบ mutually exclusive (OneOf) จะมี x-f5xc-recommended-oneof-variant เพื่อระบุว่า variant ใดที่ใช้บ่อยที่สุด ข้อมูลเมตานี้ระบุตัวเลือกทั่วไปเมื่อมีหลายตัวเลือก โดยอ้างอิงจากค่าเริ่มต้นของ F5 XC คอนโซลและรูปแบบการใช้งานทั่วไป

กลุ่ม OneOf ระดับบนสุด

Schema	กลุ่ม OneOf	Variant ที่แนะนำ	คำอธิบาย
`healthcheckCreateSpecType`	`health_check`	`http_health_check`	ประเภท HTTP health check
`healthcheckReplaceSpecType`	`health_check`	`http_health_check`	ประเภท HTTP health check

กลุ่ม OneOf ของ healthcheckHttpHealthCheck

Schema	กลุ่ม OneOf	Variant ที่แนะนำ	คำอธิบาย
`healthcheckHttpHealthCheck`	`host_header_choice`	`use_origin_server_name`	Host header สำหรับคำขอ health check

Host Header Choice

กลุ่ม OneOf host_header_choice ควบคุมวิธีการระบุ Host header ในคำขอ HTTP ของ health check

Variant	ประเภท	คำอธิบาย
`use_origin_server_name`	`object` (ว่างเปล่า)	ใช้ชื่อเซิร์ฟเวอร์ต้นทางเป็น Host header ซึ่งเป็นตัวเลือกเริ่มต้นใน F5 XC คอนโซล
`host_header`	`string`	ระบุค่า Host header แบบกำหนดเองสำหรับคำขอ health check

ข้อมูลอ้างอิง API Schema: x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

ข้อมูลอ้างอิง OpenAPI Extensions

vendor extension เหล่านี้ถูกเพิ่มเข้าไปใน OpenAPI schema มาตรฐานเพื่อสื่อถึงพฤติกรรมเริ่มต้นเฉพาะของ F5 XC

x-f5xc-server-default

ประเภท: boolean

เมื่อเป็น true ระบุว่าค่า default ที่ระบุไว้จะถูกบังคับใช้โดย F5 XC API server ฟิลด์ที่มี extension นี้สามารถละเว้นจากคำขอ 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 (map ของชื่อกลุ่มไปยังชื่อ variant)

สำหรับ schema ที่มีกลุ่มฟิลด์แบบ mutually exclusive จะระบุว่า variant ใดเป็นตัวเลือกเริ่มต้นหรือที่ใช้บ่อยที่สุด โดย key คือชื่อกลุ่ม OneOf และ value คือชื่อฟิลด์ variant ที่แนะนำ

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

การเข้าถึงข้อมูล

ข้อกำหนด API

ไฟล์	เนื้อหา
`docs/specifications/api/virtual.json`	`healthcheckHttpHealthCheck`, `healthcheckCreateSpecType`, `healthcheckReplaceSpecType`, `healthcheckGetSpecType`
`docs/specifications/api/openapi.json`	ข้อกำหนดที่รวมเข้าด้วยกันพร้อม schema ทั้งหมด

โครงสร้าง validation.json

defaults.resources.healthcheck
├── server_applied      # ฟิลด์ที่มี x-f5xc-server-default: true
├── recommended         # ฟิลด์ที่มี x-f5xc-recommended-value
├── oneof_recommended   # คำแนะนำสำหรับ OneOf variant
└── nested_recommended  # ค่าที่แนะนำสำหรับ schema ที่ซ้อนอยู่

เอกสารที่เกี่ยวข้อง

คู่มือการพัฒนา - OpenAPI Extensions - คำจำกัดความและการใช้งาน extension
ข้อกำหนดการตรวจสอบ - รูปแบบและโครงสร้างของ validation.json
การปรับปรุง Origin Pool - การเพิ่มประสิทธิภาพ schema ของ origin pool

บันทึกการเปลี่ยนแปลง

เวอร์ชัน	วันที่	การเปลี่ยนแปลง
2.1.4	2026-01-19	เพิ่มเอกสารกลุ่ม OneOf `host_header_choice` สำหรับพารามิเตอร์คำขอ HTTP health check
2.1.3	2026-01-18	รวมเอกสาร global extension ไว้ใน DEVELOPMENT.md เฉพาะข้อมูลเฉพาะทรัพยากร
2.1.2	2026-01-18	เขียนใหม่เป็นเอกสารอ้างอิง API แบบบริสุทธิ์ ลบตัวอย่าง downstream และภาษาที่เป็นการบังคับ
2.1.1	2026-01-18	เพิ่มค่าที่แนะนำสำหรับ schema ที่ซ้อนอยู่ OneOf recommended variants และ extension `x-f5xc-recommended-oneof-variant`
2.1.0	2026-01-18	เพิ่มโครงสร้าง defaults แบบรวมใน validation.json
2.0.30	2026-01-16	เพิ่ม nested defaults สำหรับ schema `$ref`
2.0.29	2026-01-17	ค่าเริ่มต้น healthcheck เริ่มต้น