- 홈
- API Enriched
- Enhancements
- 헬스체크 개선 사항
헬스체크 개선 사항
헬스체크 관련 스키마에 대한 보강 메타데이터입니다. 확장 정의는 OpenAPI 확장을 참조하십시오.
보강된 스키마
섹션 제목: “보강된 스키마”healthcheck.*SpecType과 일치하는 모든 스키마는 보강을 적용받습니다:
healthcheckCreateSpecTypehealthcheckReplaceSpecTypehealthcheckGetSpecType
또한, 중첩 스키마 healthcheckHttpHealthCheck에는 HTTP 헬스체크 구성에 대한 보강이 포함되어 있습니다.
서버 적용 기본값
섹션 제목: “서버 적용 기본값”x-f5xc-server-default: true로 표시된 필드는 요청에서 생략될 때 F5 XC API 서버에 의해 default 값이 적용됩니다.
최상위 필드
섹션 제목: “최상위 필드”| 필드 | 기본값 | 유형 | 설명 |
|---|---|---|---|
jitter | 0 | integer | 타이밍 무작위화를 위한 절대 지터 값 |
jitter_percent | 0 | integer | 타이밍 무작위화를 위한 백분율 기반 지터 |
healthcheckHttpHealthCheck 스키마
섹션 제목: “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 스키마
섹션 제목: “healthcheckHttpHealthCheck 스키마”| 필드 | 권장 값 | 유형 | 설명 |
|---|---|---|---|
path | "/" | string | 헬스체크 엔드포인트 경로 |
use_http2 | false | boolean | HTTP/2 지원 설정 |
expected_status_codes | ["200"] | array | 정상 오리진을 나타내는 상태 코드 |
use_origin_server_name | {} | object | Host 헤더에 사용할 오리진 서버 이름 |
OneOf 변형 권장 사항
섹션 제목: “OneOf 변형 권장 사항”상호 배타적인 필드 그룹(OneOf)을 포함하는 스키마에는 가장 일반적으로 사용되는 변형을 나타내는 x-f5xc-recommended-oneof-variant가 포함됩니다. 이 메타데이터는 F5 XC 콘솔 기본값 및 일반적인 사용 패턴을 기반으로 여러 옵션이 있을 때 일반적인 선택을 식별합니다.
최상위 OneOf 그룹
섹션 제목: “최상위 OneOf 그룹”| 스키마 | OneOf 그룹 | 권장 변형 | 설명 |
|---|---|---|---|
healthcheckCreateSpecType | health_check | http_health_check | HTTP 헬스체크 유형 |
healthcheckReplaceSpecType | health_check | http_health_check | HTTP 헬스체크 유형 |
healthcheckHttpHealthCheck OneOf 그룹
섹션 제목: “healthcheckHttpHealthCheck OneOf 그룹”| 스키마 | OneOf 그룹 | 권장 변형 | 설명 |
|---|---|---|---|
healthcheckHttpHealthCheck | host_header_choice | use_origin_server_name | 헬스체크 요청의 Host 헤더 |
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 고유의 기본 동작을 전달하기 위해 표준 OpenAPI 스키마에 추가됩니다.
x-f5xc-server-default
섹션 제목: “x-f5xc-server-default”유형: boolean
true일 때, 함께 제공되는 default 값이 F5 XC API 서버에 의해 적용됨을 나타냅니다. 이 확장이 있는 필드는 API 요청에서 안전하게 생략할 수 있으며, 서버가 자동으로 기본값을 적용합니다.
use_http2: type: boolean default: false x-f5xc-server-default: truex-f5xc-recommended-value
섹션 제목: “x-f5xc-recommended-value”유형: any (필드 유형과 일치)
F5 XC 웹 콘솔이 미리 채워진 기본값으로 사용하는 값을 지정합니다. 이 값은 서버에서 강제 적용되지 않지만 콘솔을 통해 생성된 새 리소스의 일반적인 초기 구성을 나타냅니다.
timeout: type: integer x-f5xc-recommended-value: 3x-f5xc-recommended-oneof-variant
섹션 제목: “x-f5xc-recommended-oneof-variant”유형: object (그룹 이름에서 변형 이름으로의 맵)
상호 배타적인 필드 그룹이 있는 스키마에 대해 기본값이거나 가장 일반적인 선택인 변형을 식별합니다. 키는 OneOf 그룹 이름이고 값은 권장 변형 필드 이름입니다.
healthcheckCreateSpecType: type: object x-f5xc-recommended-oneof-variant: health_check: "http_health_check"데이터 접근
섹션 제목: “데이터 접근”OpenAPI 사양
섹션 제목: “OpenAPI 사양”| 파일 | 내용 |
|---|---|
docs/specifications/api/virtual.json | healthcheckHttpHealthCheck, healthcheckCreateSpecType, healthcheckReplaceSpecType, healthcheckGetSpecType |
docs/specifications/api/openapi.json | 모든 스키마가 포함된 병합 사양 |
validation.json 구조
섹션 제목: “validation.json 구조”defaults.resources.healthcheck├── server_applied # x-f5xc-server-default: true인 필드├── recommended # x-f5xc-recommended-value가 있는 필드├── oneof_recommended # OneOf 변형 권장 사항└── nested_recommended # 중첩 스키마 권장 값관련 문서
섹션 제목: “관련 문서”- 개발 가이드 - 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 | 초기 헬스체크 기본값 추가 |