हेल्थचेक संवर्द्धन

हेल्थचेक-संबंधित स्कीमा के लिए संवर्धन मेटाडेटा। एक्सटेंशन परिभाषाओं के लिए OpenAPI एक्सटेंशन देखें।

संवर्धित स्कीमा

पैटर्न

healthcheck.*SpecType से मेल खाने वाले सभी स्कीमा को संवर्द्धन प्राप्त होता है:

• healthcheckCreateSpecType
• healthcheckReplaceSpecType
• healthcheckGetSpecType

इसके अतिरिक्त, नेस्टेड स्कीमा healthcheckHttpHealthCheck में HTTP हेल्थ चेक कॉन्फ़िगरेशन के लिए संवर्द्धन शामिल हैं।

सर्वर-अनुप्रयुक्त डिफ़ॉल्ट

x-f5xc-server-default: true से चिह्नित फ़ील्ड का default मान F5 XC API सर्वर द्वारा तब लागू किया जाता है जब अनुरोधों से छोड़ा जाता है।

शीर्ष-स्तरीय फ़ील्ड

फ़ील्ड	डिफ़ॉल्ट मान	प्रकार	विवरण
jitter	0	integer	टाइमिंग रैंडमाइज़ेशन के लिए निरपेक्ष jitter मान
jitter_percent	0	integer	टाइमिंग रैंडमाइज़ेशन के लिए प्रतिशत-आधारित jitter

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	प्रोडक्शन उपयोग के लिए jitter प्रतिशत

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 एक्सटेंशन संदर्भ

ये विक्रेता एक्सटेंशन F5 XC-विशिष्ट डिफ़ॉल्ट व्यवहार को व्यक्त करने के लिए मानक OpenAPI स्कीमा में जोड़े गए हैं।

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      # 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

संबंधित दस्तावेज़ीकरण

• विकास गाइड - OpenAPI एक्सटेंशन - एक्सटेंशन परिभाषाएँ और उपयोग
• सत्यापन विनिर्देश - validation.json प्रारूप और संरचना
• ऑरिजिन पूल संवर्द्धन - ऑरिजिन सर्वर पूल स्कीमा संवर्द्धन

परिवर्तन लॉग

संस्करण	दिनांक	परिवर्तन
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	प्रारंभिक हेल्थचेक डिफ़ॉल्ट