EdgeLoadBalancerHealthMonitorSummary

EdgeLoadBalancerHealthMonitorSummary
EdgeLoadBalancerHealthMonitorSummary

Specifies a summary of a Load Balancer Pool Health Monitor.

JSON Example
{
    "id": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "poolCount": 0,
    "scope": "string"
}
string
id
Optional

The identifier of a Load Balancer Health Monitor in URN format

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
Optional

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.
integer
poolCount
Optional

Number of pools associated with this Load Balancer Health Monitor.

string
scope
Optional

The definition scope of an Edge Gateway Load Balancer Health Monitor.

  • SYSTEM - Health Monitors are default profiles provided by the backing Load Balancer.
  • PROVIDER - Health Monitors are defined by the provider at a system level and associated to a Load Balancer Pool by the provider on behalf of the tenant.
  • TENANT - Health Monitors are available only for a tenant's specific Load Balancer. They are defined by the tenant or by a provider on behalf of a tenant.
Availability
Added in 39.0