コンテンツにスキップ
API Enriched

ヘルスチェックの拡張機能

ヘルスチェック関連スキーマの拡充メタデータです。拡張定義については OpenAPI 拡張機能 を参照してください。

拡充スキーマ

Section titled “拡充スキーマ”

パターン

Section titled “パターン”

healthcheck.*SpecType に一致するすべてのスキーマに拡充が適用されます：

  • healthcheckCreateSpecType
  • healthcheckReplaceSpecType
  • healthcheckGetSpecType

また、ネストされたスキーマ healthcheckHttpHealthCheck には HTTP ヘルスチェック設定の拡充が含まれます。

サーバー適用デフォルト値

Section titled “サーバー適用デフォルト値”

x-f5xc-server-default: true が付与されたフィールドは、リクエストから省略された場合に F5 XC API サーバーによって default 値が適用されます。

トップレベルフィールド

Section titled “トップレベルフィールド”
フィールドデフォルト値型説明
jitter0integerタイミングのランダム化に使用する絶対ジッター値
jitter_percent0integerタイミングのランダム化に使用するパーセンテージベースのジッター

healthcheckHttpHealthCheck スキーマ

Section titled “healthcheckHttpHealthCheck スキーマ”
フィールドデフォルト値型説明
use_origin_server_name{}objectHost ヘッダー用のオリジンサーバー名
headers{}objectカスタムヘッダー
request_headers_to_remove[]arrayリクエストから除去するヘッダー
use_http2falsebooleanHTTP/2 サポート
expected_status_codes[]array許容するステータスコード（空の場合は 200〜299）

推奨値

Section titled “推奨値”

x-f5xc-recommended-value が付与されたフィールドは、新しいリソースを作成する際に F5 XC Web コンソールが事前入力する値を示します。

トップレベルフィールド

Section titled “トップレベルフィールド”
フィールド推奨値型説明
timeout3integerヘルスチェックのタイムアウト（秒）
interval15integerヘルスチェックの間隔（秒）
unhealthy_threshold1integer非正常と判断するまでの連続失敗回数
healthy_threshold3integer正常と判断するまでの連続成功回数
jitter_percent30integer本番環境で使用するジッターのパーセンテージ

healthcheckHttpHealthCheck スキーマ

Section titled “healthcheckHttpHealthCheck スキーマ”
フィールド推奨値型説明
path"/"stringヘルスチェックのエンドポイントパス
use_http2falsebooleanHTTP/2 サポートの設定
expected_status_codes["200"]arrayオリジンが正常であることを示すステータスコード
use_origin_server_name{}objectHost ヘッダー用のオリジンサーバー名

OneOf バリアントの推奨設定

Section titled “OneOf バリアントの推奨設定”

相互排他的なフィールドグループ（OneOf）を含むスキーマには、最も一般的に使用されるバリアントを示す x-f5xc-recommended-oneof-variant が含まれます。このメタデータは、F5 XC コンソールのデフォルト設定と一般的な使用パターンに基づき、複数の選択肢がある場合の典型的な選択を示します。

トップレベルの OneOf グループ

Section titled “トップレベルの OneOf グループ”
スキーマOneOf グループ推奨バリアント説明
healthcheckCreateSpecTypehealth_checkhttp_health_checkHTTP ヘルスチェックタイプ
healthcheckReplaceSpecTypehealth_checkhttp_health_checkHTTP ヘルスチェックタイプ

healthcheckHttpHealthCheck の OneOf グループ

Section titled “healthcheckHttpHealthCheck の OneOf グループ”
スキーマOneOf グループ推奨バリアント説明
healthcheckHttpHealthCheckhost_header_choiceuse_origin_server_nameヘルスチェックリクエスト用の Host ヘッダー

Host ヘッダーの選択

Section titled “Host ヘッダーの選択”

host_header_choice OneOf グループは、ヘルスチェック HTTP リクエストにおける Host ヘッダーの指定方法を制御します。

バリアント型説明
use_origin_server_nameobject（空）オリジンサーバー名を Host ヘッダーとして使用します。これは F5 XC コンソールでのデフォルト選択です。
host_headerstringヘルスチェックリクエストにカスタム Host ヘッダー値を指定します。

API スキーマリファレンス: x-ves-oneof-field-host_header_choice: ["host_header", "use_origin_server_name"]

OpenAPI 拡張機能リファレンス

Section titled “OpenAPI 拡張機能リファレンス”

これらのベンダー拡張機能は、F5 XC 固有のデフォルト動作を伝えるために標準 OpenAPI スキーマに追加されます。

x-f5xc-server-default

Section titled “x-f5xc-server-default”

型: boolean

true の場合、付随する default 値が F5 XC API サーバーによって強制適用されることを示します。この拡張機能を持つフィールドは API リクエストから安全に省略でき、サーバーが自動的にデフォルト値を適用します。

use_http2:
  type: boolean
  default: false
  x-f5xc-server-default: true
Section titled “x-f5xc-recommended-value”

型: any（フィールドの型に対応）

F5 XC Web コンソールが事前入力されたデフォルトとして使用する値を指定します。この値はサーバーによって強制されるものではありませんが、コンソールから新しいリソースを作成する際の一般的な初期設定を表します。

timeout:
  type: integer
  x-f5xc-recommended-value: 3
Section titled “x-f5xc-recommended-oneof-variant”

型: object（グループ名からバリアント名へのマップ）

相互排他的なフィールドグループを持つスキーマに対して、デフォルトまたは最も一般的な選択肢となるバリアントを示します。キーは OneOf グループ名、値は推奨バリアントのフィールド名です。

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

データアクセス

Section titled “データアクセス”

OpenAPI 仕様

Section titled “OpenAPI 仕様”
ファイル内容
docs/specifications/api/virtual.jsonhealthcheckHttpHealthCheck、healthcheckCreateSpecType、healthcheckReplaceSpecType、healthcheckGetSpecType
docs/specifications/api/openapi.jsonすべてのスキーマを含むマージ済み仕様

validation.json の構造

Section titled “validation.json の構造”
defaults.resources.healthcheck
├── server_applied      # x-f5xc-server-default: true が付与されたフィールド
├── recommended         # x-f5xc-recommended-value が付与されたフィールド
├── oneof_recommended   # OneOf バリアントの推奨設定
└── nested_recommended  # ネストされたスキーマの推奨値

関連ドキュメント

Section titled “関連ドキュメント”

変更履歴

Section titled “変更履歴”
バージョン日付変更内容
2.1.42026-01-19HTTP ヘルスチェックリクエストパラメーターの host_header_choice OneOf グループドキュメントを追加
2.1.32026-01-18グローバル拡張機能のドキュメントを DEVELOPMENT.md に統合。リソース固有データのみを掲載
2.1.22026-01-18純粋な API リファレンスとして全面改訂。ダウンストリームの例と規範的な記述を削除
2.1.12026-01-18ネストされた推奨値、OneOf 推奨バリアント、x-f5xc-recommended-oneof-variant 拡張機能を追加
2.1.02026-01-18validation.json に統合されたデフォルト構造を追加
2.0.302026-01-16$ref スキーマのネストされたデフォルトを追加
2.0.292026-01-17ヘルスチェックの初期デフォルト値を追加