Skip to content

HealthCheckConfig

Source code in docs_src/capo_rtbfabric/types/health_check_config.py
class HealthCheckConfig(TypedDict, closed=True):
    port: "int"
    """<p>The port to use for health check probes. Valid range is 80 to 65535.</p>"""
    path: "str"
    """<p>The destination path for the health check request. Must start with <code>/</code>.</p>"""
    protocol: NotRequired["capo_rtbfabric.types.protocol.Protocol"]
    """<p>The protocol to use for health check probes.</p>"""
    timeout_ms: NotRequired["int"]
    """<p>The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.</p>"""
    interval_seconds: NotRequired["int"]
    """<p>The interval between health check probes, in seconds. Valid range is 5 to 60.</p>"""
    status_code_matcher: NotRequired[
        "capo_rtbfabric.types.status_code_matcher.StatusCodeMatcher"
    ]
    """<p>The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, <code>200</code>), a range (for example, <code>200-299</code>), or a comma-separated list (for example, <code>200,204</code>).</p>"""
    healthy_threshold_count: NotRequired["int"]
    """<p>The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.</p>"""
    unhealthy_threshold_count: NotRequired["int"]
    """<p>The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.</p>"""

healthy_threshold_count instance-attribute

healthy_threshold_count: NotRequired[int]

The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

interval_seconds instance-attribute

interval_seconds: NotRequired[int]

The interval between health check probes, in seconds. Valid range is 5 to 60.

path instance-attribute

path: str

The destination path for the health check request. Must start with /.

port instance-attribute

port: int

The port to use for health check probes. Valid range is 80 to 65535.

protocol instance-attribute

protocol: NotRequired[Protocol]

The protocol to use for health check probes.

status_code_matcher instance-attribute

status_code_matcher: NotRequired[StatusCodeMatcher]

The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

timeout_ms instance-attribute

timeout_ms: NotRequired[int]

The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

unhealthy_threshold_count instance-attribute

unhealthy_threshold_count: NotRequired[int]

The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.