Create Load Balancer Health Monitor

Create Load Balancer Health Monitor

Creates a Load Balancer Pool Health Monitor.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/loadBalancer/healthMonitors
COPY
Request Body
EdgeLoadBalancerHealthMonitor of type(s) application/json
Optional 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "systemDefined": false,
    "successfulChecksCount": 0,
    "failedChecksCount": 0,
    "sendInterval": 0,
    "receiveTimeout": 0,
    "httpSettings": {
        "port": 0,
        "requestHeader": "string",
        "requestBody": "string",
        "useExactRequest": false,
        "expectedResponseData": "string",
        "expectedResponseCodes": [
            "string"
        ],
        "authSettings": {
            "type": "string",
            "username": "string",
            "password": "string"
        }
    },
    "httpsSettings": {
        "port": 0,
        "requestHeader": "string",
        "requestBody": "string",
        "useExactRequest": false,
        "expectedResponseData": "string",
        "expectedResponseCodes": [
            "string"
        ],
        "authSettings": {
            "type": "string",
            "username": "string",
            "password": "string"
        }
    },
    "tcpSettings": {
        "port": 0,
        "requestData": "string",
        "expectedResponseData": "string"
    },
    "udpSettings": {
        "port": 0,
        "requestData": "string",
        "expectedResponseData": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    }
}
string
id
Optional

The unique ID of this Load Balancer Pool Health Monitor. On updates, the ID is required. For create, a new ID will be generated.

string
name
Optional

Name of the Health monitor. Name of the system defined monitors are prefixed with System for example 'System-HTTP'.

string
description
Optional

Description of the Load Balancer Pool Health Monitor.

string
type
Required

Type of the health monitors. A value of "-" represents an unknown type. Supported values are:

  • HTTP - HTTP request/response is used to validate health.
  • HTTPS - Used against HTTPS encrypted web servers to validate health.
  • TCP - TCP connection is used to validate health.
  • UDP - A UDP datagram is used to validate health.
  • PING - An ICMP ping is used to validate health.
Extra type-specific options can be set in the respective "settings" property.
boolean
systemDefined
Optional

Whether the Health Monitor is system defined.

integer As int32 As int32
successfulChecksCount
Optional

Number of successful checks required to mark an unhealthy Load Balancer Pool member as healthy.

integer As int32 As int32
failedChecksCount
Optional

Number of failed checks required to mark a healthy Load Balancer Pool member as unhealthy.

integer As int32 As int32
sendInterval
Optional

Frequency (in seconds) at which to send health checks to Load Balancer Pool.

integer As int32 As int32
receiveTimeout
Optional

Maximum elapsed duration (in seconds) after which a health check is considered to have failed.

EdgeLoadBalancerHealthMonitorHttpSettings
httpSettings
Optional

Specifies settings that are applicable to both HTTP and HTTPS Load Balancer Pool Health Monitors.

EdgeLoadBalancerHealthMonitorHttpsSettings
httpsSettings
Optional

Specifies settings that are applicable to a HTTPS Load Balancer Pool Health Monitor.

EdgeLoadBalancerHealthMonitorTcpSettings
tcpSettings
Optional

Specifies settings that are applicable to a TCP Load Balancer Pool Health Monitor.

EdgeLoadBalancerHealthMonitorUdpSettings
udpSettings
Optional

Specifies settings that are applicable to a UDP Load Balancer Pool Health Monitor.

EntityReference
gatewayRef
Optional

Entity reference used to describe VCD entities

Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Availability
Added in 39.0
On This Page
Edge Gateway Load Balancer Health Monitors Operations
POST
Create Load Balancer Health Monitor
DELETE
Delete Load Balancer Health Monitor
GET
Get Health Monitor Summaries For Gateway
GET
Get Load Balancer Health Monitor
PUT
Update Load Balancer Health Monitor