LBHttpsMonitorProfile

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.


integer
_revision Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


children Optional

subtree for this type within policy tree containing nested elements.


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


integer
fall_count Optional

Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.


string
id Optional

Unique identifier of this resource


integer
interval Optional

Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.


boolean
marked_for_delete Optional

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.


integer
monitor_port Optional

Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.


string
parent_path Optional

Path of its parent


string
path Optional

Absolute path of this object


string
relative_path Optional

Path relative from its parent


string
request_body Optional

String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.


request_headers Optional

Array of HTTP request headers.


string
request_method Optional

The health check method for HTTP monitor type.

Possible values are: GETOPTIONSPOSTHEADPUT


string
request_url Optional

For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.


string
request_version Optional

HTTP request version.

Possible values are: HTTP_VERSION_1_0HTTP_VERSION_1_1HTTP_VERSION_2_0


string
resource_type Optional

The type of this resource.


string
response_body Optional

If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.


array of integer
response_status_codes Optional

The HTTP response status code should be a valid HTTP status code.


integer
rise_count Optional

Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.


server_ssl_profile_binding Optional

The setting is used when the monitor acts as an SSL client and establishing a connection to the backend server.


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


integer
timeout Optional

Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Extends

LBActiveMonitor

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "fall_count": 0,
    "id": "string",
    "interval": 0,
    "marked_for_delete": false,
    "monitor_port": 0,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "request_body": "string",
    "request_headers": [
        {
            "header_name": "string",
            "header_value": "string"
        }
    ],
    "request_method": "string",
    "request_url": "string",
    "request_version": "string",
    "resource_type": "string",
    "response_body": "string",
    "response_status_codes": [
        0
    ],
    "rise_count": 0,
    "server_ssl_profile_binding": {
        "certificate_chain_depth": 0,
        "client_certificate_path": "string",
        "server_auth": "string",
        "server_auth_ca_paths": [
            "string"
        ],
        "server_auth_crl_paths": [
            "string"
        ],
        "ssl_profile_path": "string"
    },
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "timeout": 0
}
Feedback

Was this page helpful?